project_information: Project Summaries from Project IDs

In Bioconductor/hca: Exploring the Human Cell Atlas Data Coordinating Platform

Project Summaries from Project IDs

Description

project_information() queries the HCA database for project title, description, contact, DOI, and publication URI.

project_title() returns the title of the project, cleaned to remove trailing trailing ..

print.project_information() formats the result of project_information() in a more legible manner.

Usage

project_information(project_id)

project_title(project_id)

## S3 method for class 'project_information'
print(x, ...)

Arguments

project_id	character(1) project identifier, e.g., "3c9d586e-bd26-4b46-8690-3faaa18ccf38".
x	an object of class project_information, the result of a call to project_information().
...	additional arguments, required to conform with the print generic but not used.

Value

project_information() returns a tibble with a single row, and columns containing information about the project. The tibble is of class project_information and is printed in an interactive session formatted so long columns, e.g., projectDescription, are more easily read.

project_title() returns a character(1) vector containing the project title.

print.project_information() is invoked automatically when the result of project_information() is displayed for it's side effect of displaying the object.

Examples

project_id <- "3c9d586e-bd26-4b46-8690-3faaa18ccf38"
project_information(project_id)

project_title(project_id)

Bioconductor/hca documentation built on Nov. 1, 2024, 5:45 a.m.