projects {hca} | R Documentation |
projects()
takes user input to be used to query the
HCA API for information about available projects.
projects_facets()
summarizes facets and terms used by
all records in the projects index.
*_columns()
returns a tibble or named
character vector describing the content of the tibble returned
by projects()
, files()
, samples()
, or bundles()
.
projects_detail()
takes a unique project_id and catalog for
the project, and returns details about the specified project as a
list-of-lists
projects( filters = NULL, size = 1000L, sort = "projectTitle", order = c("asc", "desc"), catalog = NULL, as = c("tibble", "lol", "list"), columns = projects_default_columns("character") ) projects_facets(facet = character(), catalog = NULL) projects_default_columns(as = c("tibble", "character")) projects_detail(uuid, catalog = NULL)
filters |
filter object created by |
size |
integer(1) maximum number of results to return;
default: all projects matching |
sort |
character(1) project facet (see |
order |
character(1) sort order. One of |
catalog |
character(1) source of data. Use
|
as |
character(1) return format. Default: |
columns |
named character() indicating the paths to be used
for parsing the 'lol' returned from the HCA to a tibble. The
names of |
facet |
character() of valid facet names. Summary results (see 'Value', below) are returned when missing or length greater than 1; details are returned when a single facet is specified. |
uuid |
character() unique identifier (e.g., |
When as = "tibble"
, projects()
returns a tibble with
each row representing an HCA project, and columns summarizing
the project. Each .hit
is a single result; a result may
contain several projects, as indexed by .project
.
When `as = "lol"`, `projects()` returns a list-of-lists data structure representing detailed information on each project ('hit'). When `as = "list"`, `projects()` returns an R list, typically containing other lists or atomic vectors, representing detailed information on each project.
projects_facets()
invoked with no facet=
argument returns a
tibble summarizing terms available as projects()
return
values, and for use in filters. The tibble contains columns
- `facet`: the name of the facet. - `n_terms`: the number of distinct values the facet can take. - `n_values`: the number of occurrences of the facet term in the entire catalog. `projects_facets()` invoked with a scalar value for `facet=` returns a tibble summarizing terms used in the facet, and the number of occurrences of the term in the entire catalog.
*_columns()
returns a tibble with column name
containing the column name used in the tibble returned by
projects()
, files()
, samples()
, or bundles()
, and
path
the path (see lol_hits()
) to the data in the
list-of-lists by the same functions when as = "lol"
. When as = "character"
, the return value is a named list with paths as
elements and abbreviations as names.
list-of-lists containing relevant details about the project.
lol()
and other lol_*()
functions for working with the
list-of-list data structure returned when as = "lol"
.
projects(filters()) projects_facets() projects_facets("genusSpecies") projects_default_columns() projects_detail( uuid = "4a95101c-9ffc-4f30-a809-f04518a23803", catalog = "dcp1" )