createUmiExperiment {umiAnalyzer}

Method for creating a UMI experiment object

Description

Method for creating a UMI experiment object

Usage

createUmiExperiment(
  mainDir,
  experimentName = NULL,
  sampleNames = NULL,
  importBam = FALSE,
  as.shiny = FALSE
)

Arguments

mainDir

Main experiment directory

experimentName

Name of the experiment

sampleNames

List of sample names. Can be either NULL or list. If NULL all subdirectories of mainDir will be searched.

importBam

Logical. Should bam files be imported on creation? Default is False.

as.shiny

Set to TRUE if run within a shiny::withProgress environment

Value

An object of class UMIexperiment

Examples

library(umiAnalyzer)

main = system.file('extdata', package = 'umiAnalyzer')

samples <- list.dirs(path = main, full.names = FALSE, recursive = FALSE)

exp1 <- createUmiExperiment(experimentName = 'exp1',mainDir = main,sampleNames = samples)