sim_fastq: Simulation of fastq-files

Description Usage Arguments Details Value Examples

Description

This function produces paired fastq-files based on the statistical distributions of the original sam-files which are generated by the function sim_init. The simulated paired fastq-files will be stored in the fastq-directory.

Usage

1
2
3
4
5
6
sim_fastq(
  file_indices = rep(NA_integer_, 0),
  read_counts,
  start_positions_and_read_lengths,
  seed
)

Arguments

file_indices

Indices of the sam-files from which the rds-objects are used to simulate the paired fastq-files.

read_counts

If the number of reads are "original", the number of reads generated per virus is identical to the read counts of the sam-file. By specifying the parameter as "density", there is the possibility to change the number of reads generated randomly based on a kernel density estimation of the original number of reads mapped to the species. In the latter case, the number of reads of the mapped species which are to be generated differs slightly from the original distribution.

start_positions_and_read_lengths

If the start positions and read lengths are "original", the start positions and read lengths are taken from the original sam-files so that every read is used exactly once. In contrary, if the parameter setting is "random", the reads are sampled with replacement so that some reads may be used multiple or zero times.

seed

Seed of the random number generator used to create random base nucleotides and quality values based on the provided statistical distributions.

Details

Do not use read_counts = "density" in combination with start_positions_and_read_lengths = "original"! Before using the function sim_fastq, the functions create_directories_and_file_paths, extract_information_from_reference_genome and sim_init must be executed.

Value

None

Examples

1
sim_fastq ( file_indices = 1 , read_counts = "density", start_positions_and_read_lengths = "random", seed = 42 ) # Takes a few seconds to run!

Moritz-Kohls/virDisco2 documentation built on Feb. 13, 2020, 12:32 a.m.