fastx_trimmer: Wrapper function for fastx_trimmer

In kathrynrozengagnon/CLIPflexR: CLIP tools and wrappers in R

Wrapper function for fastx_trimmer

Description

Wrapper function for fastx_trimmer

Usage

fastx_trimmer(
  fileTofqt,
  fqt = "fastx_trimmer",
  read_start = 10,
  read_end = NULL,
  qEncoding = NULL,
  outFile = paste0(file_path_sans_ext(fileTofqt), "_trim.", file_ext(fileTofqt)),
  writelog = T,
  stderr = file.path(dirname(fileTofqt), paste0(basename(fileTofqt),
    "_trimmer_stats_stderr.txt")),
  stdout = file.path(dirname(fileTofqt), paste0(basename(fileTofqt),
    "_trimmer_stats_stdout.txt")),
  useClipRConda = ifelse(is.null(getOption("CLIPflexR.condaEnv")), FALSE, TRUE),
  additional_Args = NULL,
  verbose = FALSE
)

Arguments

fileTofqt	path to file to process (fastq or fasta).
fqt	path to fastx_trimmer from FastX toolkit.
read_start	read starting base (default is 10).
read_end	read ending base (default is NULL, set to integer to trim).
qEncoding	quality encoding, set to either 33 (Sanger Phred+33 encoding/Illumina fastq) or NULL (Phred+64 fastq or fasta; default).
outFile	output file path.
writelog	write stderr/stdout logs, TRUE (default) or FALSE.
stderr	path to stderr file.
stdout	path to stdout file.
useClipRConda	use conda environment installed by Herper, TRUE (default) or FALSE.
additional_Args	additional arguments to be passed to system call.
verbose	print messages to screen, TRUE or FALSE (default).

Value

path to trimmed file.

Author(s)

Kathryn Rozen-Gagnon

Examples

testFQ <- system.file("extdata/Fox3_Std_small.fq.gz",package="CLIPflexR")
FqFile_FF <- ctk_fastqFilter(testFQ,qsFilter = "mean:0-29:20",verbose=TRUE)
FqFile <- decompress(FqFile_FF,overwrite=TRUE)
FqFile_trimmed <- fastx_trimmer(FqFile,read_start = 5, read_end = 50)

kathrynrozengagnon/CLIPflexR documentation built on Dec. 8, 2022, 7:31 p.m.