addSampleTable: Adds sample table

View source: R/mapping.R

addSampleTableR Documentation

Adds sample table

Description

Adds a sample table to an rms object

Usage

addSampleTable(rms.obj, sample.tbl)

Arguments

rms.obj

An list with RMS data structures, see RMSobject.

sample.tbl

A table with sample metadata (data.frame or tibble).

Details

This small function just adds a table with metadata about samples to an already existing rms.obj. The latter is a list, and this function only ensures the added element is correctly named Sample.tbl.

If the supplied rms.obj already contains a Sample.tbl, it is simply replaced by the new sample.tbl.

The sample.tbl must contain at least the two columns sample_id and fasta_file. The first is a unique text to identify each sample, the latter is the name of the fasta file with processed reads, see readMapper.

Value

A list similar to the input rms.obj, but with one new element added.

Author(s)

Lars Snipen.

See Also

RMSobject.


larssnip/microRMS documentation built on July 19, 2023, 1:06 a.m.