Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jonclayden committed Jun 19, 2024
1 parent 2e1627a commit a19f0ee
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 5 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ License: GPL-2
URL: https://github.com/jonclayden/RNifti
BugReports: https://github.com/jonclayden/RNifti/issues
Encoding: UTF-8
RoxygenNote: 7.2.3
RoxygenNote: 7.3.1
Roxygen: list(old_usage=TRUE)
9 changes: 7 additions & 2 deletions R/rgb.R
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,14 @@
#' dimensions of \code{red} are used if this is \code{NULL}.
#' @param ... For \code{rgbArray}, additional attributes to set on the result,
#' such as \code{pixdim}. These are passed directly to
#' \code{\link{structure}}. For the \code{as.character} method, this argument
#' is ignored.
#' \code{\link{structure}}. For the indexing method, additional indices.
# For the \code{as.character} method, this argument is ignored.
#' @param x An \code{rgbArray} object.
#' @param i,j Index vectors, which are passed to the \code{array} method.
#' @param drop Whether or not to drop unitary dimensions. \code{rgbArray}
#' objects currently always have a \code{dim} attribute, so if the result is
#' a vector it will have a remaining single-element dimension equal to its
#' length.
#' @param flatten Logical value. If \code{FALSE}, the dimensions of \code{x}
#' will be retained in the result. The default is \code{TRUE}, for
#' consistency with the usual behaviour of \code{as.character}, which strips
Expand Down
10 changes: 8 additions & 2 deletions man/rgbArray.Rd

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

0 comments on commit a19f0ee

Please sign in to comment.