Read feature metadata — readFeatMetadata • GiottoClass

read feature metadata from listt

Usage

readFeatMetadata(
  data_list,
  default_spat_unit = NULL,
  default_feat_type = NULL,
  provenance = NULL,
  verbose = TRUE
)

Arguments

data_list: nested list of feature metadata information
default_spat_unit: (optional) default spat_unit to use
default_feat_type: (optional) default feat_type to use
provenance: (optional) provenance information
verbose: be verbose

Value

featMetadata

Examples

df <- data.frame(
    feat_ID = c("feat_1", "feat_2", "feat_3"),
    geneID = c("gene_1", "gene_1", "gene_2")
)
temporal_dir <- tempdir()
write.csv(df, paste0(temporal_dir, "/metadata.csv"), row.names = FALSE)

readFeatMetadata(paste0(temporal_dir, "/metadata.csv"))
#> list depth of 2
#> 
#> List item [1]:
#>  spat_unit: cell
#>  feat_type: rna
#> [[1]]
#> An object of class featMetaObj 
#> spat_unit : "cell"
#> feat_type : "rna"
#> provenance: cell 
#> 
#>    feat_ID geneID
#>     <char> <char>
#> 1:  feat_1 gene_1
#> 2:  feat_2 gene_1
#> 3:  feat_3 gene_2
#>