saveConsData: Save consensus data

Description Usage Arguments Value Examples

View source: R/utilities.R

Description

If save is set to TRUE data will be written to a csv file otherwise consensus data will be returned as a tibble.

Usage

1
2
3
4
5
6
7
saveConsData(
  object,
  save = FALSE,
  fileName = "consensus_data.csv",
  outDir = getwd(),
  delim = ";"
)

Arguments

object

UMIexperiment object

save

Logical. Should data be saved to file? Default is FALSE.

fileName

String. Name of the file to be saved. Default is 'consensus_data.csv'

outDir

output directory, defaults to working directory

delim

Single character string, either ';' or ',' or tab

Value

A data table

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
library(umiAnalyzer)

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

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

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

consensus_data <- saveConsData(object = example)
consensus_data

umiAnalyzer documentation built on Nov. 25, 2021, 9:07 a.m.