Metadata: Metadata class

In road2stat/sbgr: R Client for Seven Bridges Genomics API (v1)

Description

Metadata class

Details

This function will help you create a Metadata object, what it does it to accept a named list or just pass meta key-value pairs as argument one by one. Then it first matches SBG's build-in meta field which will be shown in the graphic interface on the platform, then save extra meta information in extra field, but not visible on the platform yet, you can view it via the API.

There are four pre-defined fields with pre-defined levels, they are file_type, qual_scale, seq_tech, and paired_end, those are also constructor names to construct a single Enum object, it's different from characters, it has validation against levels, to check their levels, you can simply create a empty Metadata object and access the field levels. Please see examples.

References

https://docs.sbgenomics.com/display/sbg/Metadata

Examples

m <- Metadata()
## to check levels
m$file_type
levels(m$file_type)
## to replace a Enum class need to use constructor
m$file_type <- file_type("text")

road2stat/sbgr documentation built on March 9, 2021, 4:33 a.m.