HuBMAP Samples — samples • HuBMAPR

samples() returns details about available samples, ordered by last modified dates. There are multiple tissue sample types displayed in sample_category column which are block, organ, suspension, and section.

*_columns() returns a tibble or named character vector describing the content of the tibble returned by samples(), datasets(), donors(), collections(), or publications().

sample_detail() takes a unique sample_id and returns details about one specified sample as a tibble

sample_derived() takes a unique sample_id and returns the derived dataset or/and sample details.

sample_metadata() takes a unique donor_id and returns the metadata of the sample.

Usage

samples()

samples_default_columns(as = c("tibble", "character"))

sample_detail(uuid)

sample_derived(uuid, entity_type = c("Dataset", "Sample"))

sample_metadata(uuid)

Arguments

as: character(1) return format. One of "tibble" (default), or "character".
uuid: character(1) corresponding to the HuBMAP Donor UUID string. This is expected to be a 32-digit hex number.
entity_type: character(1) selected derived entity type. One of "Sample" or "Dataset" (default).

Value

*_columns() returns a named list name containing the column name used in the tibble returned by samples(), datasets(), donors(), collections(), or publications(). When as = "tibble",the return value is a tibble with paths as elements and abbreviations as names.

Details

Additional details are provided on the HuBMAP consortium webpage, https://software.docs.hubmapconsortium.org/apis

Examples

samples()
#> # A tibble: 3,036 × 7
#>    uuid              hubmap_id donor_hubmap_id group_name last_modified_timest…¹
#>    <chr>             <chr>     <chr>           <chr>      <chr>                 
#>  1 ff78b3739e397acb… HBM258.Z… HBM544.CDJS.566 Vanderbil… 2025-04-17            
#>  2 5c638b02d249cc85… HBM723.Z… HBM672.HSNT.629 Vanderbil… 2025-04-15            
#>  3 09af77a53cd7d037… HBM632.S… HBM245.VFCF.396 Vanderbil… 2025-04-15            
#>  4 9affaeb6324cca96… HBM699.Z… HBM395.HCTC.292 Vanderbil… 2025-04-15            
#>  5 45573b69ef0b3510… HBM269.Z… HBM924.QHJN.586 Vanderbil… 2025-04-14            
#>  6 e7cfa168d20491b7… HBM399.P… HBM425.SQGM.878 Vanderbil… 2025-04-14            
#>  7 3fcc51e98a9f2d3b… HBM948.K… HBM486.QQFH.565 Vanderbil… 2025-04-14            
#>  8 ea2cfa5b4d1ed386… HBM925.W… HBM368.WSHR.356 Vanderbil… 2025-04-14            
#>  9 db346f684630db7e… HBM364.W… HBM758.JRSC.348 Vanderbil… 2025-04-14            
#> 10 427d58dbfe9d4b39… HBM987.M… HBM547.NCQL.874 Vanderbil… 2025-04-14            
#> # ℹ 3,026 more rows
#> # ℹ abbreviated name: ¹last_modified_timestamp
#> # ℹ 2 more variables: sample_category <chr>, organ <chr>
samples_default_columns()
#> # A tibble: 7 × 1
#>   columns                
#>   <chr>                  
#> 1 uuid                   
#> 2 hubmap_id              
#> 3 group_name             
#> 4 sample_category        
#> 5 organ                  
#> 6 last_modified_timestamp
#> 7 donor_hubmap_id        

uuid <- "d3525d35f6d5ee3dc3186613b0ab1762"
sample_detail(uuid)
#> # A tibble: 1 × 23
#>   ancestor_ids ancestors  created_by_user_displayname created_by_user_email
#>   <list>       <list>     <chr>                       <chr>                
#> 1 <chr [3]>    <list [3]> Marda Jorgensen             marda@ufl.edu        
#> # ℹ 19 more variables: created_timestamp <dbl>, data_access_level <chr>,
#> #   descendant_ids <list>, descendants <list>, display_subtype <chr>,
#> #   donor <list>, entity_type <chr>, group_name <chr>, group_uuid <chr>,
#> #   hubmap_id <chr>, immediate_ancestor_ids <list>,
#> #   immediate_descendant_ids <list>, index_version <chr>,
#> #   last_modified_timestamp <dbl>, origin_samples <list>, protocol_url <chr>,
#> #   rui_location <chr>, sample_category <chr>, uuid <chr>
uuid <- "3e7dc14313262af577f686dcb09f5119"
sample_derived(uuid, "Sample")
#> # A tibble: 1 × 2
#>   uuid                             organ
#>   <chr>                            <chr>
#> 1 63ef1040ae30473778dc4bd2f2749fe3 Brain
uuid <- "8d7ce3aab7013e416263d23b0c048900"
sample_metadata(uuid)
#> # A tibble: 9 × 2
#>   Key                   Value                                                   
#>   <chr>                 <chr>                                                   
#> 1 donor.Age             "54 years"                                              
#> 2 donor.Body Mass Index "53.06 kg/m2"                                           
#> 3 donor.Cause of Death  "Anoxia "                                               
#> 4 donor.Height          "157.48 cm"                                             
#> 5 donor.Medical History "Type 2 Diabetes Mellitus ; Hypertension ; Asthma ; Chr…
#> 6 donor.Race            "Black or African American "                            
#> 7 donor.Sex             "Female "                                               
#> 8 donor.Social History  "Smoker ; Illicit drug use "                            
#> 9 donor.Weight          "131.6 kg"