diff --git a/R/MeanDims.R b/R/MeanDims.R index ea16c96ab31bc841c64e8898c96062c9c3047b65..8a6dc56856c30630e90770e3ecec7321b48a58ea 100644 --- a/R/MeanDims.R +++ b/R/MeanDims.R @@ -7,7 +7,7 @@ #'@param dims A vector of numeric or charactor string, indicating along which #' dimensions to average. #'@param na.rm A logical value indicating whether to ignore NA values (TRUE) or -#' not (FALSE). +#' not (FALSE). The default value is FALSE. #' #'@return An array with the same dimension as parameter 'data' except the 'dims' #' dimensions. @@ -19,7 +19,7 @@ #'print(dim(MeanDims(a, c(2, 3)))) #'print(dim(MeanDims(a, c('a', 'b')))) #'@export -MeanDims <- function(data, dims, na.rm = TRUE) { +MeanDims <- function(data, dims, na.rm = FALSE) { # Check inputs ## data diff --git a/man/MeanDims.Rd b/man/MeanDims.Rd index f2140f31fd9bb2476c97f4348f42c3bf6780affd..ed621e48f4af6bae862920fea2fec60191d84be8 100644 --- a/man/MeanDims.Rd +++ b/man/MeanDims.Rd @@ -4,7 +4,7 @@ \alias{MeanDims} \title{Average an array along multiple dimensions} \usage{ -MeanDims(data, dims, na.rm = TRUE) +MeanDims(data, dims, na.rm = FALSE) } \arguments{ \item{data}{An array to be averaged.} @@ -13,7 +13,7 @@ MeanDims(data, dims, na.rm = TRUE) dimensions to average.} \item{na.rm}{A logical value indicating whether to ignore NA values (TRUE) or -not (FALSE).} +not (FALSE). The default value is FALSE.} } \value{ An array with the same dimension as parameter 'data' except the 'dims'