readArgs: Read arguments for a sampletrees run from a settings file

Description Usage Arguments Value Author(s) References Examples

View source: R/pre_sampletrees.R

Description

This function is used to read in settings for a sampletrees run that have been previously saved to a file.

Usage

1
readArgs(filename, check=TRUE)

Arguments

filename

The name of the input file with the sampletrees settings

check

If TRUE, error checking of the settings will be done (default=TRUE)

Value

Returns an object of class 'pars' with settings from the input file

Author(s)

Kelly Burkett

References

Burkett KM, McNeney B, Graham J. Sampletrees and Rsampletrees: sampling gene genealogies conditional on SNP genotype data. Bioinformatics. 32:1580-2, 2016

Examples

1
2
3
4
5
filename=paste(path.package("Rsampletrees"),"/extdata/example_g_pars",sep="")
runpars=readArgs(filename, check=FALSE)
runname=paste(path.package("Rsampletrees"),"extdata",runpars$RunName, sep="/")
runpars=changeArgs(runpars, RunName=runname)
print.pars(runpars)

Rsampletrees documentation built on March 3, 2020, 1:07 a.m.