reportSampleNames: convenient reporting of sample name and design

Description Usage Arguments Details Value Author(s)

View source: R/ReportSampleNames.R

Description

convenient reporting of sample name and design

Usage

1
2
3
4
5
6
7
reportSampleNames(
  ramclustObj = NULL,
  which.data = "SpecAbund",
  delim = "-",
  cmpdlabel = "cmpd",
  filename = NULL
)

Arguments

ramclustObj

ramclustR object summarize

which.data

character; which dataset (SpecAbund or SpecAbundAve) to perform PCA on.

delim

character; "-" by default - the delimiter for parsing sample names to factors

cmpdlabel

= "cmpd"; label the data with the annotation. can also be set to 'ann' for column names assigned as annotatins.

Details

convenience function reporting of sample names. writes text file with sample summary.

Value

returns a ramclustR Object, with sample summary appended to 'sampleSummary'slot.

Author(s)

Corey Broeckling


cbroeckl/csu.pmf.tools documentation built on Nov. 25, 2021, 1:20 p.m.