Doc update

SantanderMetGroup · May 9, 2017 · 413ff08 · 413ff08
1 parent e1c894e
commit 413ff08
Show file tree

Hide file tree

Showing 24 changed files with 28 additions and 190 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -35,7 +35,6 @@ export(prinComp)
 export(redim)
 export(rescaleGrid)
 export(selectPar.pplyFun)
-export(subsetDecadalForecast)
 export(subsetDimension)
 export(subsetGrid)
 export(subsetMembers)
@@ -77,5 +76,6 @@ importFrom(stats,na.exclude)
 importFrom(stats,na.omit)
 importFrom(stats,qnorm)
 importFrom(stats,sd)
+importFrom(utils,globalVariables)
 importFrom(utils,packageDescription)
 importFrom(utils,tail)
diff --git a/NEWS b/NEWS
@@ -2,6 +2,9 @@ transformeR 0.0.10
 =================
 
 * Bug fix in internal function for reference date retrieval
+* Package size reduced (CRAN compliant):
+  * Deleted several unused built-in datasets
+  * EOBS tp and tas DJF datasets trimmed to the 5-year period 1996-2000
 * Other minor changes and documentation updates
 
 

diff --git a/R/onAttach.R b/R/onAttach.R
@@ -24,3 +24,7 @@
 }
 # End
 
+#' @importFrom utils globalVariables
+
+if (getRversion() >= "3.1.0") utils::globalVariables(c("node.list", "l1"))
+
diff --git a/R/plotClimatology.R b/R/plotClimatology.R
@@ -57,7 +57,7 @@
 #' @author J. Bedia
 #' @seealso \code{\link{climatology}}. See \code{\link[sp]{spplot}} in package \pkg{sp} for further information on
 #' plotting capabilities and options
-#' @examples \donttest{
+#' @examples 
 #' data(tasmax_forecast)
 #' # Climatology is computed:
 #' clim <- climatology(tasmax_forecast, by.member = TRUE)
@@ -110,9 +110,9 @@
 #'                 names.attr = c("DEC","JAN","FEB"),
 #'                 main = "Mean PSL climatology 1991-2010",
 #'                 scales = list(draw = TRUE))                
-#' }
 #' 
 
+
 plotClimatology <- function(grid, backdrop.theme = "none", ...) {
       arg.list <- list(...)
       bt <- match.arg(backdrop.theme, choices = c("none", "coastline", "countries"))
@@ -153,14 +153,15 @@ plotClimatology <- function(grid, backdrop.theme = "none", ...) {
 #'@keywords internal
 #'@export
 #'@author J. Bedia
-#'@examples \donttest{
+#'@importFrom sp GridTopology SpatialGridDataFrame
+#'@examples 
 #' data(tasmax_forecast)
 #' # Climatology is computed:
 #' clim <- climatology(tasmax_forecast, by.member = TRUE)
 #' sgdf <- clim2sgdf(clim)
 #' class(sgdf)
-#' spplot(sgdf)
-#' }
+
+
 
 clim2sgdf <- function(clim) {
       grid <- clim

diff --git a/R/rdas.R b/R/rdas.R
@@ -69,58 +69,7 @@ NULL
 #'                 backdrop.theme = "coastline")
 NULL
 
-#' @title Station daily precipitation dataset
-#' @description Station data from the VALUE_ECA_86_v2 dataset containing daily precipitation for 82 stations in Europe.
-#' @format Station data
-#' @name VALUE_tp
-#' @docType data
-#' @source  Subset of VALUE station data. Full dataset is accessible 
-#' for download in \url{http://meteo.unican.es/work/downscaler/data/VALUE_ECA_86_v2.tar.gz}.
-NULL
-
-#' @title Station mean temperature dataset
-#' @description Station data from the VALUE_ECA_86_v2 dataset containing daily mean temperature for 82 stations in Europe.
-#' @format Station data
-#' @name VALUE_tas
-#' @docType data
-#' @source  Subset of VALUE station data. Full dataset is accessible 
-#' for download in \url{http://meteo.unican.es/work/downscaler/data/VALUE_ECA_86_v2.tar.gz}.
-NULL
-
-
-#' @title Station daily precipitation data
-#' @description Station data from the VALUE_ECA_86_v2 dataset containing daily precipitation for the Igueldo-SanSebastian station. 
-#' @format Station data
-#' @name VALUE_Igueldo_tp
-#' @docType data
-#' @source  Subset of VALUE station data. Full dataset is accessible 
-#' for download in \url{http://meteo.unican.es/work/downscaler/data/VALUE_ECA_86_v2.tar.gz}.
-NULL
-
-#' @title Station mean temperature data
-#' @description Station data from the VALUE_ECA_86_v2 dataset containing daily mean temperature for the Igueldo-SanSebastian station. 
-#' @format Station data
-#' @name VALUE_Igueldo_tas
-#' @docType data
-#' @keywords VALUE station temperature Igueldo
-#' @source  Subset of VALUE station data. Full dataset is accessible 
-#' for download in \url{http://meteo.unican.es/work/downscaler/data/VALUE_ECA_86_v2.tar.gz}.
-NULL
-
-#' @title Decada forecast example grid
-#' @description Grid of decadal forecast data from the SPECS_GFDL_decadal dataset containing monthly temperature for the Iberian Peninsula. 
-#' @format Grid data
-#' @name tas_decadalForecast
-#' @docType data
-#' @keywords SPECS temperature decadal forecast
-#' @source  Subset of the SPECS_GFDL_decadal dataset. This data is accessible 
-#' for loading in the \strong{The User Data Gateway (UDG)}, which is the one stop shop for 
-#' climate data access maintained by the Santander MetGroup. 
-#' The UDG builds on the THREDDS Access Portal (UDG-TAP) which is the entry point for 
-#' authentication and data access (more info in \url{https://meteo.unican.es/trac/wiki/udg}). 
-NULL
-
-#' @title Grid containing E-OBS daily data of mean temperature for the Iberian Peninsula (DJF, 1991-2000).
+#' @title Grid containing E-OBS daily data of mean temperature for the Iberian Peninsula (DJF, 1998-2000).
 #' @description EOBS_Iberia_tas is a grid object returned by \code{loadECOMS} from package \pkg{loadeR.ECOMS}
 #' @format A grid
 #' @name EOBS_Iberia_tas
@@ -134,7 +83,8 @@ NULL
 #'                 backdrop.theme = "countries", scales = list(draw = TRUE))
 NULL
 
-#' @title Grid containing E-OBS daily data of precipitation for the Iberian Peninsula (DJF, 1991-2000).
+
+#' @title Grid containing E-OBS daily data of precipitation for the Iberian Peninsula (DJF, 1998-2000).
 #' @description EOBS_Iberia_tp is a grid object returned by \code{loadECOMS} from package \pkg{loadeR.ECOMS}
 #' @format A grid
 #' @name EOBS_Iberia_tp
@@ -149,7 +99,7 @@ NULL
 #'                                      aggr.y = list(FUN = sum))
 #' plotClimatology(climatology(total.precip.annual), 
 #'                 backdrop.theme = "countries", scales = list(draw = TRUE),
-#'                 main = "Mean Total DJF precip (mm) 1991-2000")
+#'                 main = "Mean Total DJF precip (mm) 1998-2000")
 
 NULL
 

diff --git a/R/rescaleGrid.R b/R/rescaleGrid.R
@@ -46,6 +46,7 @@
 #' @importFrom abind abind asub
 #' @importFrom stats na.omit
 #' @return A rescaled grid
+#' @author J. Bedia
 #' @export
 
 rescaleGrid <- function(grid,

diff --git a/R/subsetDecadalForecast.R b/R/subsetDecadalForecast.R
@@ -8,26 +8,8 @@
 #' @return A grid object with an additional dimension corresponding to the selected lead years. 
 #' @author M. Iturbide
 #' @importFrom abind abind
-#' @export
-#' @examples \dontrun{
-#' latLim <- c(35,45)
-#' lonLim <-  c(-10,2)
-#' season <- 3:5
-#' period <- 1981:1982
-#' loginUDG(username = "myuser", password = "mypassword") #type help(loginUDG)
-#' tas_decadalForecast <- loadDecadalForecast(
-#'    dataset = "http://www.meteo.unican.es/tds5/dodsC/specs/gfdl_specs_decadal.ncml", 
-#'    latLim = latLim, 
-#'    lonLim = lonLim,
-#'    var = "tas", 
-#'    dictionary = F, 
-#'    years = period, 
-#'    season = season)
-#' 
-#' data(tas_decadalForecast)
-#' # data corresponding to the initialitation of the two years before
-#' subsetDecadalForecast(tasDECA, ly = c(1,2))
-#' }
+#' @keywords internal
+
 
 subsetDecadalForecast <- function(data, ly = c(1,2)){
       init <- data$InitializationDates      

diff --git a/data/EOBS_Iberia_tas.rda b/data/EOBS_Iberia_tas.rda
diff --git a/data/EOBS_Iberia_tp.rda b/data/EOBS_Iberia_tp.rda
diff --git a/data/VALUE_Igueldo_tas.rda b/data/VALUE_Igueldo_tas.rda
diff --git a/data/VALUE_Igueldo_tp.rda b/data/VALUE_Igueldo_tp.rda
diff --git a/data/VALUE_tas.rda b/data/VALUE_tas.rda
diff --git a/data/VALUE_tp.rda b/data/VALUE_tp.rda
diff --git a/man/EOBS_Iberia_tas.Rd b/man/EOBS_Iberia_tas.Rd
diff --git a/man/EOBS_Iberia_tp.Rd b/man/EOBS_Iberia_tp.Rd
diff --git a/man/VALUE_Igueldo_tas.Rd b/man/VALUE_Igueldo_tas.Rd
diff --git a/man/VALUE_Igueldo_tp.Rd b/man/VALUE_Igueldo_tp.Rd
diff --git a/man/VALUE_tas.Rd b/man/VALUE_tas.Rd
diff --git a/man/VALUE_tp.Rd b/man/VALUE_tp.Rd
diff --git a/man/clim2sgdf.Rd b/man/clim2sgdf.Rd
diff --git a/man/plotClimatology.Rd b/man/plotClimatology.Rd
diff --git a/man/rescaleGrid.Rd b/man/rescaleGrid.Rd
diff --git a/man/subsetDecadalForecast.Rd b/man/subsetDecadalForecast.Rd
diff --git a/man/tas_decadalForecast.Rd b/man/tas_decadalForecast.Rd
-Original file line number
+Diff line change
@@ Expand Up / @@ -24,3 +24,7 @@ @@
     }
     # End
+    #' @importFrom utils globalVariables
+    if (getRversion() >= "3.1.0") utils::globalVariables(c("node.list", "l1"))