ethseq.Analysis: Ethnicity analysis from whole-exome sequencing data

Description Usage Arguments Value

View source: R/ethseq_Analysis.R

Description

This function performs ethnicity analysis of a set of samples ad reports the results.

Usage

1
2
3
4
5
6
ethseq.Analysis(target.vcf = NA, target.gds = NA, bam.list = NA,
  out.dir = "/tmp", model.gds = NA, model.available = NA,
  model.folder = "/tmp", run.genotype = FALSE, aseq.path = "/tmp",
  mbq = 20, mrq = 20, mdc = 10, cores = 1, verbose = TRUE,
  composite.model.call.rate = 1, refinement.analysis = NA, space = "2D",
  bam.chr.encoding = FALSE)

Arguments

target.vcf

Path to the sample's genotypes in VCF format

target.gds

Path to the sample's genotypes in GDS format

bam.list

Path to a file containing a list of BAM files paths

out.dir

Path to the folder where the output of the analysis is saved

model.gds

Path to a GDS file specifying the reference model

model.available

String specifying the pre-computed reference model to use (SS2,SS4,NimblegenV3,HALO,Exonic)

model.folder

Path to the folder where reference models are already present of downloaded when needed

run.genotype

Logical values indicating wheter the ASEQ genotype should be run

aseq.path

Path to the folder where ASEQ binary is available of is downloaded when needed

mbq

Minmum base quality used in the pileup by ASEQ

mrq

Minimum read quality used in the piluep by ASEQ

mdc

Minimum read count accettable for genotype inference by ASEQ

cores

Number of parallel cores used for the analysis

verbose

Print detaild information

composite.model.call.rate

SNP call rate used to run Principal Component Analysis (PCA)

refinement.analysis

Matrix specyfing a tree of ethnicities

space

Dimensions of PCA space used to infer ethnicity (2D or 3D)

bam.chr.encoding

Logical value indicating whether input BAM files have chromosomes encoded with "chr" prefix

Value

Logical value indicating the success of the analysis


aromanel/EthSEQ documentation built on Dec. 15, 2017, 6:35 p.m.