get_metadata {ribor} | R Documentation

## Retrieves the metadata of an experiment

### Description

`get_metadata` provides information on all of the user-inputted metadata of an experiment. If the experiment is not found, then the attributes of the root .ribo file is returned instead.

### Usage

    get_metadata(ribo.object, name = NULL, print = TRUE)

### Arguments

`ribo.object` | object of class 'ribo'
`name` | The name of the experiment
`print` | Logical value indicating whether or not to neatly print the output

### Value

If a valid experiment name is provided, a list of elements providing all of the metadata of the experiment is returned.

If the name is not provided and the root file has metadata, then a list of elements providing all of the metadata found in the root file is returnend.

### See Also

`Ribo` to generate the necessary ribo.object parameter

### Examples

    #ribo object use case
    #generate the ribo object
    file.path <- system.file("extdata", "sample.ribo", package = "ribor")
    sample <- Ribo(file.path)

    #the ribo file contains an experiment named 'Hela_1'
    get_metadata(sample, "Hela_1")

[Package ribor version 1.2.0 Index]