sampleDataset: Sample dataset object

View source: R/sampleDataset.R

sampleDatasetR Documentation

Sample dataset object

Description

Create a sample dataset object that contains all information needed to perform a sample quality control. The Dataset object is a list with one dataframe and

Usage

sampleDataset(bamQcMetr = NULL, vcfQcMetr = NULL, annotations,
  primaryID = NULL, df = NULL)

Arguments

bamQcMetr

a data frame that contains BAM level QC metrics

vcfQcMetr

a data frame that contains VCF level QC metrics

annotations

a data frame that contains annotations of the samples.

df

optional, an R dataframe that contains all sample level data, including QC metrics and sample annotations. When df is provided, bamQcMetr, vcfQcMetr and annotations should be vectors with names of corresponding fields.

Value

an sampleDataset object.


xiaolicbs/samplyzer documentation built on Sept. 4, 2023, 9:23 p.m.