vcf_sort: Sort VCF file

Description Usage Arguments

View source: R/util.R

Description

This function takes a VCF file and sorts it genomic order

Usage

1
2
3
4
5
6
7
8
vcf_sort(
  bin_path = "tools/bcftools/bcftools",
  vcf = "",
  verbose = FALSE,
  output_dir = "",
  ram = 4,
  tmp_dir = ""
)

Arguments

bin_path

Required Path to bcftools binary. Default tools/bcftools/bcftools.

vcf

Required Path to VCF file to sort.

verbose

Optional Enables progress messages. Default False.

output_dir

Optional Path to the output directory. Default working directory.

ram

Required RAM in GB to allocate sorting. Default 4Gb.

tmp_dir

Optional Path to tmp file directory.


TearsWillFall/variantCall documentation built on Oct. 15, 2021, 8:51 p.m.