get_metadata {slinky} | R Documentation

## get_metadata

### Description

The accessor function retrieves metadata from Slinky object.

### Usage

    get_metadata(x)

    ## S4 method for signature 'Slinky'
    get_metadata(x)

### Arguments

`x` | a Slinky object

### Details

As it turns out 'metadata' was a poor choice for the accessor function because it can be masked if the user loads the 'SummarizedExperiment' package after slinky. So this provides an alternative. Eventually 'slinky::metadata' should be deprecated.

### Value

The accessor function returns a `data.frame` containing the metadata.

### Examples

    # for build/demo only.  You MUST use your own key when using the slinky
    # package.
    user_key <- httr::content(httr::GET('https://api.clue.io/temp_api_key'),
                              as='parsed')$user_key
    sl <- Slinky(user_key,
                     system.file('extdata', 'demo.gctx',
                          package='slinky'),
                     system.file('extdata', 'demo_inst_info.txt',
                         package = 'slinky'))
    md <- get_metadata(sl[, 1:10])

[Package slinky version 1.2.2 Index]