Get information about the .ribo file

Description

The function get_info provides information on the attributes, metadata, and datasets of the ribo file.

Usage

get_info(ribo.object)

Arguments

Details

The get_info first provides information on the format version, left_span, right_span, longest read length, shortest read length, metagene_radius, and reference model. The last element of the returned list contains the information about the presence of coverage and RNA-seq data which are optional datasets to include in a .ribo file.

Value

Returns a list containing a nested list of file attributes, a logical value denoting whether the root file has additional metadata, and a data.frame of information on each experiment

See Also

Ribo to generate the necessary ribo.object parameter

Examples

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

#retrieve information
get_info(sample)