Skip to content

Commit

Permalink
Minor docfix.
Browse files Browse the repository at this point in the history
  • Loading branch information
LTLA committed Dec 29, 2023
1 parent 806ae3b commit d19842f
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions R/readRangedSummarizedExperiment.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
#' Read a \linkS4class{RangedSummarizedExperiment} from its on-disk representation.
#' This is usually not directly called by users, but is instead called by dispatch in \code{\link{readObject}}.
#'
#' @param path String containing a path to a directory, itself created using the \code{\link{stageObject}} method for \linkS4class{RangedSummarizedExperiment} objects.
#' @param path String containing a path to a directory, itself created using the \code{\link{saveObject}} method for \linkS4class{RangedSummarizedExperiment} objects.
#' @param metadata Named list of metadata for this object, see \code{\link{readObjectFile}} for details.
#' @param ... Further arguments passed to \code{\link{readSummarizedExperiment}} and internal \code{\link{altReadObject}} calls.
#'
#' @return A \linkS4class{RangedSummarizedExperiment} object.
#'
#' @author Aaron Lun
#' @seealso
#' \code{"\link{saveObject,RangedSummarizedExperiment-method}"}, to save the SummarizedExperiment to disk.
#' \code{"\link{saveObject,RangedSummarizedExperiment-method}"}, to save the RangedSummarizedExperiment to disk.
#'
#' @examples
#' # Mocking up an experiment:
Expand Down
2 changes: 1 addition & 1 deletion R/readSummarizedExperiment.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#' Read a \linkS4class{SummarizedExperiment} from its on-disk representation.
#' This is usually not directly called by users, but is instead called by dispatch in \code{\link{readObject}}.
#'
#' @param path String containing a path to a directory, itself created using the \code{\link{stageObject}} method for \linkS4class{SummarizedExperiment} objects.
#' @param path String containing a path to a directory, itself created using the \code{\link{saveObject}} method for \linkS4class{SummarizedExperiment} objects.
#' @param metadata Named list of metadata for this object, see \code{\link{readObjectFile}} for details.
#' @param ... Further arguments passed to internal \code{\link{altReadObject}} calls.
#'
Expand Down
4 changes: 2 additions & 2 deletions man/readRangedSummarizedExperiment.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/readSummarizedExperiment.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit d19842f

Please sign in to comment.