diff --git a/DESCRIPTION b/DESCRIPTION index be4e28e..2dca710 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -60,7 +60,7 @@ SystemRequirements: GNU make biocViews: GeneticVariability, GenomicVariation, Preprocessing License: MIT + file LICENSE Encoding: UTF-8 -RoxygenNote: 7.3.1 +RoxygenNote: 7.3.2 VignetteBuilder: knitr LinkingTo: Rcpp diff --git a/R/digestFastqs.R b/R/digestFastqs.R index 33b73e7..fe43ec0 100644 --- a/R/digestFastqs.R +++ b/R/digestFastqs.R @@ -174,7 +174,8 @@ #' will be written. The name(s) should end in .gz (the output will always #' be compressed). If empty, filtered reads will not be written to a file. #' @param maxNReads Integer scalar, the maximum number of reads to process. -#' If set to -1, all reads in the FASTQ file(s) will be processed. +#' The first \code{maxNReads} read (pairs) in the FASTQ file(s) will be +#' used. If set to -1, all reads in the FASTQ file(s) will be processed. #' @param verbose Logical scalar, whether to print out progress messages. #' @param nThreads Numeric scalar, the number of threads to use for parallel #' processing. diff --git a/man/digestFastqs.Rd b/man/digestFastqs.Rd index ede7120..a871108 100644 --- a/man/digestFastqs.Rd +++ b/man/digestFastqs.Rd @@ -213,7 +213,8 @@ will be written. The name(s) should end in .gz (the output will always be compressed). If empty, filtered reads will not be written to a file.} \item{maxNReads}{Integer scalar, the maximum number of reads to process. -If set to -1, all reads in the FASTQ file(s) will be processed.} +The first \code{maxNReads} read (pairs) in the FASTQ file(s) will be +used. If set to -1, all reads in the FASTQ file(s) will be processed.} \item{verbose}{Logical scalar, whether to print out progress messages.}