new_stats_bam_samtools: Generate BAM file flag and index stats

In TearsWillFall/ULPwgs: An implementation of a wrapper for estimating tumor fraction in ultra-low-pass whole genome sequencing (ULP-WGS) for cell-free DNA in GNU/Unix based systems

Generate BAM file flag and index stats

Description

Generate BAM file flag and index stats

Usage

new_stats_bam_samtools(
  bin_samtools = build_default_tool_binary_list()$bin_samtools,
  bam = NULL,
  stats = "all",
  ...
)

Arguments

bin_samtools	Path to bwa executable. Default path tools/samtools/samtools.
bam	Path to the input file with the sequence.
stats	Generate BAM stats. Default all. Options "all","flag","index",""
output_dir	Path to the output directory.
verbose	Enables progress messages. Default False.
threads	Number of threads. Default 3
ram	RAM per thread to use. Default 4.
mode	REQUIRED Where to parallelize. Default local. Options "local","batch"
executor_id	Task EXECUTOR ID. Default "mardupsGATK"
task_name	Name of the task. Default "mardupsGATK"
time	OPTIONAL If batch mode. Max run time per job. Default "48:0:0"
update_time	OPTIONAL If batch mode. Job update time in seconds. Default 60.
wait	OPTIONAL If batch mode wait for batch to finish. Default FALSE
hold	OPTIONAL Hold job until job is finished. Job ID.

TearsWillFall/ULPwgs documentation built on April 18, 2024, 3:45 p.m.