Doc update

DESCRIPTION

@@ -21,8 +21,8 @@ Suggests:
     visualizeR
 Type: Package
 Title: An R package for climate data manipulation and transformation
-Version: 1.1.2
-Date: 2017-11-23
+Version: 1.2.0
+Date: 2017-12-13
 Authors@R: as.person(c(
     "Santander Meteorology Group <http://meteo.unican.es> [cph]",
     "Jorge Bano Medina <[email protected]> [ctb]",

NEWS

@@ -1,10 +1,18 @@
-transformeR 1.1.2
+transformeR 1.2.0
 =================
 
+* New helper functions (mainly for downscaling):
+    * `convert2bin`, for binary grid calculation based on user-defined thresholds
+    * `dataSplit`, for dataset folding along time dimension
+    * `filterNA`, for missing value removal
+* Changed the variable naming convention when multigrids are created. Now the vertical level (when defined) is appended to the name of the variable, following the definition  `"var@@level"`.
+
+Other minor bug fixes and changes:
+
 * Bug fix in `subsetSeason` (exit with message when attempting to aggregate already annual grids)
 * Bug fix in `makeMultigrid` attribute retrieval from input grids
-* Changed the variable naming convention when multigrids are created. Now the vertical level (when defined) is appended to the name of the variable, following the definition  `"var@@level"`. 
-* Other minor documentation updates
+* Renamed precipitation dataset suffixes (tp --> pr)
+* Several documentation updates
 
 
 

R/convert2bin.R

@@ -27,6 +27,7 @@
 #' @author J. Bano-Medina
 #' @importFrom stats quantile
 #' @export
+#' @family downscaling.helpers
 #' @examples
 #' # Take a look at the data:
 #' head(VALUE_Iberia_pr$Data)
@@ -62,4 +63,4 @@ convert2bin. <- function(x,threshold, partial) {
     x[x < threshold] <- 0}
   else {
     x[x < threshold] <- 0}
-return(x)}
+return(x)}

R/dataSplit.R

@@ -29,7 +29,7 @@
 #' third and fourth would be the train set.
 #' @param scale A logical value. Indicates if the data should be estandardized (i.e., 0 mean and 1 standard deviation).
 #' @return A list containing the grids x and y splitted.
-#' 
+#' @family downscaling.helpers
 #' @author J. Bano-Medina
 #' @export
 #' @examples

R/filterNA.R

@@ -21,8 +21,9 @@
 #' @return A new grid object without missing values
 #' @details The function also takes care of adjusting dates and other relevant metadata (via the internal \code{\link{subsetDimension}}).
 #' 
-#' @importFrom magrittr %>% 
-#' @author J. Bano-Medina
+#' @importFrom magrittr %>% extract2
+#' @author J. Bano-Medina, J. Bedia
+#' @family downscaling.helpers
 #' @export
 #' @examples
 #' # Check if the dataset contains missing values (YES):
@@ -34,12 +35,14 @@
 #' getShape(na.filtered)
 
 filterNA <- function(grid) {
-  if (!anyNA(grid$Data)) {
-    message("NOTE: No missing values were found in the input grid")} 
-  else {
-    time.ind <- grep("time", getDim(grid))
-    na.index <- which(!is.finite(grid$Data), arr.ind = TRUE) %>% as.data.frame() %>% extract2(time.ind) %>% unique()
-    na.index <- setdiff(1:getShape(grid, "time"), na.index)
-    grid <- subsetDimension(grid, dimension = "time", indices = na.index)
-    attr(grid$Variable, "subset") <- "filterNA"}
-    return(grid)}
+    if (!anyNA(grid$Data)) {
+        message("NOTE: No missing values were found in the input grid")
+    } else {
+        time.ind <- grep("time", getDim(grid))
+        na.index <- which(!is.finite(grid$Data), arr.ind = TRUE) %>% as.data.frame() %>% extract2(time.ind) %>% unique()
+        na.index <- setdiff(1:getShape(grid, "time"), na.index)
+        grid <- subsetDimension(grid, dimension = "time", indices = na.index)
+        attr(grid$Variable, "subset") <- "filterNA"
+    }
+    return(grid)
+}

R/makeMultiGrid.R

@@ -15,9 +15,6 @@
 #     You should have received a copy of the GNU General Public License
 #     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-
-
-
 #' @title Multigrid constructor 
 #' @description Constructs a (possibly multimember) multigrid from different (multimember) grids.
 #' A multigrid can be considered as a \dQuote{stack} of grids with similar spatiotemporal extents,
@@ -62,6 +59,7 @@
 #' multimember grids should be interpolated individually prior to multigrid construction.  
 #' @export
 #' @importFrom abind abind
+#' @family downscaling.helpers
 #' @author J. bedia 
 #' @seealso \code{\link{interpGrid}} for spatial consistency of input grids.
 #' 

R/plotClimatology.R

@@ -74,7 +74,7 @@
 #'  \code{\link{map.lines}}, to add lines and polygons to climatological maps
 #' Also see \code{\link[sp]{spplot}} in package \pkg{sp} for further information on plotting capabilities and options
 #' @examples
-# data("CFS_Iberia_tas")
+#' data("CFS_Iberia_tas")
 # # Climatology is computed:
 # clim <- climatology(CFS_Iberia_tas, by.member = TRUE)
 # plotClimatology(clim)