SnapATAC (version 1.0.0)

createSnap: Create a snap object from a snap file

Description

This function takes a snap-format file as input and create a snap object.

Usage

createSnap(file, sample, description, do.par, num.cores)

Arguments

file

Name of a snap-format file.

sample

A short sample name (i.g. "MOS.rep1").

description

Description of the experiment [NULL].

do.par

A logical variable indicates if run this using multiple processors [FALSE].

num.cores

Number of processers to use [1].

Value

A snap object

Examples

# NOT RUN {
file.name = system.file("extdata", "demo.snap", package = "SnapATAC");
demo.sp = createSnap(file.name, sample="demo", do.par=FALSE);

# }