validateSampInfo: Validate sample information

Description Usage Arguments Value

View source: R/validators.R

Description

Evaluates integrity of the grouping variable at the sample information data frame.

Usage

1
2
3
4
5
6
7
validateSampInfo(
  sampInfo,
  groupCol,
  mat,
  checkNames = TRUE,
  checkSingleSample = TRUE
)

Arguments

sampInfo

The sample information data frame.

groupCol

The column containing the grouping variable.

mat

Matrix containing data. If provided, it will check number of columns in mat.

checkNames

Check if grouping variable contains syntactically valid names? If TRUE, they are fixed in the output data frame.

checkSingleSample

Check if any group contains only one sample? A warning message appears if true.

Value

The checked sampInfo data frame


martingarrido/biokit documentation built on June 27, 2021, 2:21 a.m.