API

A fake vcf file generator

fake_vcf.get_version() → str

Retrieve the version of the package.

Returns:

str: The version of the package, or ‘unknown’ if the version cannot be found.

fake_vcf.vcf_generator.fake_vcf_data(fake_vcf_path, num_rows, num_samples, chromosome, seed, sample_prefix, phased, large_format, reference_dir_path)

Generates fake VCF data and writes it to either a file or standard output.

Args:

fake_vcf_path (Path or None): Path to the fake VCF file or None to write to standard output. num_rows (int): Number of rows. num_samples (int): Number of samples. chromosome (str): Chromosome identifier. seed (int): Random seed for reproducibility. sample_prefix (str): Prefix for sample names. phased (bool): Phased or unphased genotypes. large_format (bool): Use large format VCF. reference_dir_path (Path or None): Path to imported reference data.

fake_vcf.vcf_generator.to_std_out(virtual_vcf: VirtualVCF) → None

Writes VirtualVCF data to standard output.

Args:

virtual_vcf (VirtualVCF): VirtualVCF object containing the data.

fake_vcf.vcf_generator.to_vcf_file(virtual_vcf: VirtualVCF, fake_vcf_path: Path, num_rows: int) → None

Writes VirtualVCF data to a VCF file.

Args:

virtual_vcf (VirtualVCF): VirtualVCF object containing the data. fake_vcf_path (Path): Path to the fake VCF file. num_rows (int): Number of rows.