Skip to content

Commit 127709e

Browse files
committed
update wideFormat docs
1 parent 2e64510 commit 127709e

File tree

2 files changed

+10
-12
lines changed

2 files changed

+10
-12
lines changed

R/MultiAssayExperiment-helpers.R

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -527,13 +527,12 @@ setMethod("longForm", "ANY", function(object, colDataCols, i = 1L, ...) {
527527
#' See the `wideFormat` section for description of the `colDataCols` and
528528
#' `i` arguments.
529529
#'
530-
#' @param check.names (logical default TRUE) Column names of the output
531-
#' `DataFrame` will be checked for syntactic validity and made unique,
532-
#' if necessary
530+
#' @param check.names `logical(1)` Column names of the output `DataFrame` will
531+
#' be run through `make.names` to ensure syntactic validity (default `TRUE`).
533532
#'
534-
#' @param collapse (character default "_") A single string delimiter for output
535-
#' column names. In `wideFormat`, experiments and rownames (and when
536-
#' replicate samples are present, colnames) are seperated by this delimiter
533+
#' @param collapse `character(1)` A single string delimiter (default "_") for
534+
#' output column names. In `wideFormat`, experiments and `rownames` (and when
535+
#' replicate samples are present, `colnames`) are separated by this delimiter
537536
#'
538537
#' @export wideFormat
539538
wideFormat <- function(object, colDataCols = NULL, check.names = TRUE,

man/MultiAssayExperiment-helpers.Rd

Lines changed: 5 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)