list.experiments: List current experiment available

In ORFik: Open Reading Frames in Genomics

Description

Will only search .csv extension, also exclude any experiment with the word template.

Usage

list.experiments(
  dir = "~/Bio_data/ORFik_experiments/",
  pattern = "*",
  libtypeExclusive = NULL,
  BPPARAM = bpparam()
)

Arguments

dir	directory for ORFik experiments: default: "~/Bio_data/ORFik_experiments/"
pattern	allowed patterns in experiment file name: default ("*", all experiments)
libtypeExclusive	search for experiments with exclusivly this libtype, default (NULL, all)
BPPARAM	how many cores/threads to use? default: bpparam()

Value

a data.table, 1 row per experiment with columns experiment (name), libtypes

Examples

## Make your experiments
df <- ORFik.template.experiment(TRUE)
df2 <- df[1:6,] # Only first 2 libs
## Save them
# save.experiment(df, "~/Bio_data/ORFik_experiments/exp1.csv")
# save.experiment(df2, "~/Bio_data/ORFik_experiments/exp1_subset.csv")
## List all experiment you have:
## Path above is default path, so no dir argument needed
#list.experiments()
#list.experiments(pattern = "subset")
## For non default directory experiments
#list.experiments(dir = "MY/CUSTOM/PATH)

ORFik documentation built on March 27, 2021, 6 p.m.