docs: documented missing argument

UCLouvain-CBIO · Jun 22, 2023 · 4f59dcd · 4f59dcd
1 parent 182c33f
commit 4f59dcd
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/R/readSCP.R b/R/readSCP.R
@@ -167,7 +167,7 @@ readSCP <- function(featureData, colData, batchCol, channelCol,
 ##'     the column names are composed of special characters like `(`
 ##'     or `-` that will be converted to a `.` by the `read.csv`
 ##'     function. If `ecol` does not match, the error message will
-##'     dislpay the column names as seen by the `read.csv` function.
+##'     display the column names as seen by the `read.csv` function.
 ##'
 ##' @param fnames An optional `character(1)` or `numeric(1)`
 ##'     indicating the column to be used as row names.
@@ -240,6 +240,9 @@ readSingleCellExperiment <- function(table,
 ##'     file generated by DIA-NN. This argument is optional and is 
 ##'     only applicable for mulitplixed experiments 
 ##'
+##' @param ecol A `character(1)` indicating which column in 
+##'     `reportData` contains the quantitative information.
+##'
 ##' @param multiplexing A `character(1)` indicating the type of 
 ##'     multiplexing used in the experiment. Provide `"none"` if the
 ##'     experiment is label-free (default). Available options are:

diff --git a/man/readSCPfromDIANN.Rd b/man/readSCPfromDIANN.Rd
diff --git a/man/readSingleCellExperiment.Rd b/man/readSingleCellExperiment.Rd