process_ascat: Prepare ASCAT data from PCF select BAM files

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

Prepare ASCAT data from PCF select BAM files

Description

Prepare ASCAT data from PCF select BAM files

Usage

process_ascat(
  tumour_log2 = NULL,
  normal_log2 = NULL,
  tumour_baf = NULL,
  normal_baf = NULL,
  ref_dataset = "battenberg",
  gender = "XY",
  genome_version = "HG19",
  gamma = 1,
  penalty = 25,
  panel_version = "V3",
  output_dir = ".",
  verbose = FALSE,
  ascat_ref = build_default_reference_list(),
  batch_config = build_default_preprocess_config(),
  threads = 8,
  ram = 4,
  mode = "local",
  executor_id = make_unique_id("prepareASCAT"),
  task_name = "prepareASCAT",
  time = "48:0:0",
  update_time = 60,
  wait = FALSE,
  hold = NULL
)

Arguments

ref_dataset	OPTIONAL Reference dataset for panel allele and loci selection. Default battenberg
gender	OPTIONAL Sample gender. Default XY.
genome_version	OPTIONAL Genome reference version. Default HG19.
gamma	OPTIONAL Gamma parameter. Default 1.
penalty	OPTIONAL Penalty parameter. Default 25.
output_dir	OPTIONAL Path to the output directory.
verbose	OPTIONAL Enables progress messages. Default False.
ascat_ref	OPTIONAL List with default references.
batch_config	OPTIONAL List with default references.
threads	OPTIONAL Number of threads to split the work. Default 4
ram	OPTIONAL RAM memory to asing to each thread. Default 4
mode	REQUIRED Where to parallelize. Default local. Options "local","batch"
executor_id	Task EXECUTOR ID. Default "recalCovariates"
task_name	Task name. Default "recalCovariates"
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.
tumour	REQUIRED Path to tumour BAM file.
normal	REQUIRED Path to normal BAM file.
version	OPTIONAL PCF Select panel version. Default V3.

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