readSnpMatrix: Read in the snp-pileup generated SNP read count matrix file

View source: R/facets-wrapper.R

readSnpMatrixR Documentation

Read in the snp-pileup generated SNP read count matrix file

Description

Read in the snp-pileup generated SNP read count matrix file

Usage

readSnpMatrix(
  filename,
  skip = 0L,
  err.thresh = Inf,
  del.thresh = Inf,
  perl.pileup = FALSE,
  MandUnormal = FALSE,
  spanT = 0.2,
  spanA = 0.2,
  spanX = 0.2,
  gbuild = "hg19",
  ReferencePileupFile = NULL,
  ReferenceLoessFile = NULL,
  MinOverlap = 0.9,
  useMatchedX = FALSE,
  refX = FALSE,
  unmatched = FALSE,
  donorCounts = FALSE
)

Arguments

filename

counts file from snp-pileup

skip

(character) Skip n number of lines in the input file.

err.thresh

(numeric) Error threshold to be used to filter snp-pileup data frame.

del.thresh

(numeric) Deletion threshold to be used to filter snp-pileup data frame.

perl.pileup

(logical) Is the pileup data generated using perl pileup tool?

MandUnormal

(logical) Is CNLR analysis to be peformed using unmatched reference normals?

spanT

(numeric) Default span value to be used for loess normalization in tumor sample.

spanA

(numeric) Default span value to be used for loess normalization across autosomal chromosomes in the normal sample.

spanX

(numeric) Default span value to be used for loess normalization in Chr X in the normal sample.

gbuild

(character) Genome build (Default: hg19).

ReferencePileupFile

(character) Filepath to an optional snp-pileup generated pileup data of one or more reference normals.

ReferenceLoessFile

(character) Filepath to an optional loess data, generated using the facets2n package, of one or more reference normals. The number of normals in this data should match that in the ReferencePileupFile, and should be in the same order.

MinOverlap

(numeric) Mininum overlap fraction of loci between a tumor pileup and reference pileup data.

useMatchedX

(logical) Is the matched normal to be used for ChrX normalization?

refX

(logical) Use matched or reference normal for chrX normalization. excludes unmatched normals, such as pooled references, present in tumor counts matrix.

unmatched

(logical) is the tumor being analyzed unmatched

donorCounts

(logical) is the counts matrix baseline donor sample(s)

Value

A dataframe of pileup depth values for Tumor and Matched Normal if MandUnormal is FALSE. Else, a list of data frame with pileup depth values of Tumor, matched Normal, and a best unmatched normal, and the associated span values.


rptashkin/facets2n documentation built on May 11, 2022, 1:34 p.m.