get_experiments: Provides a list of experiments from a .ribo file

Description Usage Arguments Details Value See Also Examples

View source: R/info_functions.R

Description

The function get_experiments provides a list of experiment names in the .ribo file.

Usage

1
get_experiments(ribo.object)

Arguments

ribo.object

S4 object of class "Ribo"

Details

get_experiments returns a list of strings denoting the experiments. It obtains this by reading directly from the .ribo file through the path of the 'ribo.object' parameter. To generate the param 'ribo.object', call the Ribo function and provide the path to the .ribo file of interest.

The user can then choose to create a subset from this list for any specific experiments of interest for later function calls. Many functions that have the param 'experiment.list' call get_experiments to generate a default list of all experiments in the .ribo file.

Value

A list of the experiment names

See Also

Ribo to generate the necessary ribo.object parameter

Examples

1
2
3
4
5
6
#generate the ribo object
file.path <- system.file("extdata", "sample.ribo", package = "ribor")
sample <- Ribo(file.path)

#get a list of the experiments
get_experiments(sample)

ribosomeprofiling/ribor documentation built on May 21, 2021, 8:02 a.m.