make_example_vcf_file: Generate a basic example VCF file
In dandewaters/VCF2Ploidy: VCF File Converter

Description Usage Arguments Details Examples

Generate a basic example VCF file

make_example_vcf_file(
  save_path = "./generated_example.vcf",
  min_reads = 8,
  max_reads = 200,
  num_loci = 10,
  num_specimens = 5
)

`save_path`	the file path and file name to save the generated VCF file
`min_reads`	the minimum of total number of reads per locus
`max_reads`	the maximum of total number of reads per locus
`num_loci`	the number of loci (rows) to generate in the file
`num_specimens`	the number of specimen (columns) to generate in the file

The generated file will hold no meaningful information, this function is here only for testing the converter function.

## Not run: make_example_vcf_file()
## Not run: make_example_vcf_file(save_path="./my_example.vcf")
## Not run: make_example_vcf_file(min_reads=24, max_reads=100)
## Not run: make_example_vcf_file(num_loci=100, num_specimens=4)

dandewaters/VCF2Ploidy documentation built on Jan. 17, 2021, 2:12 p.m.