Clarify documentation of maxNReads argument

fmicompbio · Aug 9, 2024 · cef6377 · cef6377
1 parent 4df9d70
commit cef6377
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git 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
@@ -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