samples {hca} | R Documentation |
samples()
takes a list of user provided project titles
to be used to query the HCA API for information about available samples.
samples_detail()
takes a unique sample_id and catalog for
the sample, and returns details about the specified sample as a
list-of-lists
samples( filters = NULL, size = 1000L, sort = "projectTitle", order = c("asc", "desc"), catalog = NULL, as = c("tibble", "lol", "list"), columns = samples_default_columns("character") ) samples_facets(facet = character(), catalog = NULL) samples_default_columns(as = c("tibble", "character")) samples_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., |
samples_detail()
returns a list-of-lists containing
relevant details about the sample
title <- paste( "Tabula Muris: Transcriptomic characterization of 20 organs and tissues", "from Mus musculus at single cell resolution" ) filters <- filters( projectTitle = list(is = title) ) samples(filters = filters) samples_facets() samples_detail( uuid = "46b58d7b-7143-4c0a-88f3-73d0409eb453", catalog = "dcp1" )