add_comparison: add_comparison

In alex-kalinka-cruk/fgcMetadata: FGC CRISPR Metadata system

Description

Adds a comparison to an object of class fgcMeta, as produced by fgcMetadata::start_fgc_project.

Usage

add_comparison(
  meta,
  name,
  experiment,
  plasmid,
  time_point_days,
  screen_goal,
  screen_type,
  library_annotation
)

Arguments

meta	An object of class fgcMeta, as produced by fgcMetadata::start_fgc_project.
name	A name for the comparison.
experiment	The name of one or more experiments in meta$experiment$title.
plasmid	A plasmid name - must exist in meta$plasmid.
time_point_days	An integer giving the time_point_duration_in_days in experiment.
screen_goal	A screen goal, e.g. "lethality" or "sensitivity".
screen_type	A single letter designating the screen type: "n" (knock-out), "a" (activation), or "i" (interference).
library_annotation	The name of the library annotation, e.g. "yusa_v3_human.1".

Value

Returns an object of class fgcMeta. Also saves data to comparison.csv and comparison_sample.csv in meta$data_dir.

alex-kalinka-cruk/fgcMetadata documentation built on Oct. 29, 2020, 2:53 a.m.