phase.ref: Phase reference vcf file.

In jk2236/RecordMatching: Statistical detection of relatives typed with disjoint forensic and biomedical loci

Description

This function phase reference vcf file (ref.f) with BEAGLE.

Usage

phase.ref(
  ref.f,
  nthreads = 1,
  niterations = 10,
  lowmem = "false",
  window = 50000,
  overlap = 3000,
  impute = "true",
  cluster = 0.005,
  gprobs = "false",
  ne = 1e+06,
  err = 1e-04,
  seed = -99999,
  modelscale = 0.8
)

Arguments

ref.f	A name (including full path) of a file containing SNP-STR haplotypes to be used as a reference panel for imputation. Note that the reference panel must be phased and have no missing values.
nthreads	(positive integer) Number of threads for BEAGLE, default=1.
niterations	(positive integer) Number of phasing iterations in BEAGLE, default=10.
lowmem	(true/false) Whether a memory efficient algorithm should be used, default=false.
window	(positive integer) The number of markers to include in each sliding window, default=50000.
overlap	(positive integer) The number of markers of overlap between sliding windows, default=3000.
cluster	(non-negative number) The maximum cM distance between individual markers that are combined into an aggregate marker when imputing ungenotyped markers, default=0.005.
ne	(integer) The effective population size when imputing ungenotyped markers, default=1000000.
err	(nonnegative number) The allele miscall rate, default=0.0001.
seed	(integer) The seed for the random number generator, default=-99999.
modelscale	(positive number) the model scale parameter when sampling haplotypes for unrelated individuals, default=0.8.
snp.f	A name (including full path) of a file containing SNPs. Must be a standard vcf format.
map.f	A name (including full path) of a file genetic map in plink format.
marker	Name of a STR locus to be imputed.
maxlr	(number ≥ 1) The maximum likelihood ratio at a genotype, default=1000000.

Details

The phased reference file is to be used as a reference panel for BEAGLE imputation. The output file is saved under ref_phased folder within the base folder. The output file name is the same as ref.f but with _phs postfix.

Value

None

See Also

BEAGLE manual.

jk2236/RecordMatching documentation built on Dec. 21, 2021, 12:10 a.m.