From d42fad4620982faf04313972c1b2a3298dc4be10 Mon Sep 17 00:00:00 2001
From: aho <an.ho@bsc.es>
Date: Fri, 27 Mar 2020 18:00:52 +0100
Subject: [PATCH] Change MeanDims() na.rm default to FALSE to be in line with
 mean()

---
 R/MeanDims.R    | 4 ++--
 man/MeanDims.Rd | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/R/MeanDims.R b/R/MeanDims.R
index ea16c96..8a6dc56 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 f2140f3..ed621e4 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' 
-- 
GitLab