View source: R/check-annotation-keys.R
valid_annotation_keys | R Documentation |
Checks for and returns the valid annotation keys in a data framae, Synapse file, or Synapse file view.
valid_annotation_keys(x, annotations, ...) ## S3 method for class ''NULL'' valid_annotation_keys(x, annotations, ...) ## S3 method for class 'synapseclient.entity.File' valid_annotation_keys(x, annotations, syn, ...) ## S3 method for class 'data.frame' valid_annotation_keys(x, annotations, ...) ## S3 method for class 'synapseclient.table.CsvFileTable' valid_annotation_keys(x, annotations, ...)
x |
An object to check. |
annotations |
A data frame of annotation definitions. Must contain at
least three columns: |
... |
Additional parameters passed to |
syn |
Synapse client object |
A vector of valid annotation keys present in x
.
NULL
: Return NULL
synapseclient.entity.File
: Valid annotation keys on a Synapse file
data.frame
: Valid annotation keys in a data frame
synapseclient.table.CsvFileTable
: Valid annotation keys in a Synapse table
annots <- data.frame( key = c("assay", "fileFormat", "fileFormat", "fileFormat", "species"), value = c("rnaSeq", "fastq", "txt", "csv", "Human"), columnType = c("STRING", "STRING", "STRING", "STRING", "STRING") ) dat1 <- data.frame(x = 1) dat2 <- data.frame(assay = "rnaSeq") valid_annotation_keys(dat1, annots) valid_annotation_keys(dat2, annots)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.