read_sample_metadata_file: Read a sample metadata file.

In cancerit/RCRISPR: R Functions for CRISPR-Related Analyses

Read a sample metadata file.

Description

Read in a sample metadata file to a SampleMetadata object.

Usage

read_sample_metadata_file(
  filepath = NULL,
  filename_column = 1,
  label_column = 2,
  plasmid_column = 3,
  control_column = 4,
  treatment_column = 5,
  group_column = NULL,
  reads_column = NULL,
  file_separator = "\t",
  file_header = TRUE,
  ...
)

Arguments

filepath	Character string specifying a file path.
filename_column	the index of column containing sample count fileanames.
label_column	the index of column containing sample names/labels.
plasmid_column	the index of column showing whether sample is a plasmid sample.
control_column	the index of column showing whether sample is a control sample.
treatment_column	the index of column showing whether sample is a treatment sample.
group_column	the index of column containing sample group.
reads_column	the index of column containing total sequencing reads per sample.
file_separator	count file separator.
file_header	count file header.
...	additional read.delim parameters.

Value

a SampleMetadata object..

See Also

SampleMetadata-class

cancerit/RCRISPR documentation built on April 26, 2023, 10:12 p.m.