load_from_xlsx: Create experiment

Description Usage Arguments Details Value

View source: R/loxcode_experiment.R

Description

Create a loxcode_experiment from xlsx sample table.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
load_from_xlsx(
  name,
  s,
  dir,
  suffix_R1,
  suffix_R2,
  load = TRUE,
  full = FALSE,
  sat = FALSE
)

Arguments

name

string, name of the experiment

s

string, path to user-specified Excel file containing experiment samples.

dir

string, path to directory containing fastq files

suffix_R1

string, R1 suffix

suffix_R2

string, R2 suffix

load

boolean, whether to load samples or not (default is TRUE)

full

boolean, whether to produce full debugging output (default is FALSE, this uses significantly more memory)

sat

boolean, whether to keep saturation info

Details

Must contain the following columns:

* 'sample' – sample name. This is used as the unique identifier for the sample

* 'prefix' – sample prefix. suffix_R1 and suffix_R2 are appended to this

* 'meta' – sample metadata. This is user specified

* 'min_r1_len' – minimum R1 length

* 'min_r2_len' – minimum R2 length

Value

loxcode_experiment object


jngwehi/loxcodeR documentation built on March 17, 2020, 5:32 p.m.