svhound: SVhound

View source: R/svhound.R

svhoundR Documentation

SVhound

Description

TODO

Usage

 sv_hound(structuralVariantsData="data/my_sv_dataset.svalleles", window_size=10000, output_prefix="my_sv_dataset") 

Arguments

structuralVariantsData

Input dataset, it can be a VCF file for which parsing instructions will be given or a TSV file output from vcf_parser_for_svhound.py

window_size

Integer that denotes the size of the windows in kilobases used to discretize the genome.

output_prefix

Prefix of the output file.

subsample

Number of genomes/individuals to be sampled from the 'structuralVariantsData'. It needs to be an integer greater than zero. Default=NULL

usePSF

Parameter to use the Pitman Sampling Formula instead of the Ewens Sampling Formula as the model. TURE/FALSE, default=FALSE

giveExampleData

Returns an example of the TSV file output from vcf_parser_for_svhound.py loaded in R. Default=FALSE

runExample

Runs the example dataset. Default=FALSE


lfpaulin/SVhound documentation built on July 27, 2022, 3:43 a.m.