Changes between Version 29 and Version 30 of EcomsUdg/RPackage/Functions

Timestamp:

May 27, 2013 10:00:44 AM (8 years ago)

Author:

juaco

Comment:

--

EcomsUdg/RPackage/Functions

@@ -164 +164 @@
 
 {{{
-loadGCM(dataset, var, standard.vars = TRUE, dictionary = NULL, lonLim=NULL, latLim=NULL, level=NULL, startDate=NULL, endDate=NULL, season=NULL)
+loadGCM(dataset, var, standard.vars=TRUE, dictionary=NULL, lonLim=NULL, latLim=NULL, level=NULL, season=NULL, years=NULL)
 }}}
 
@@ -175 +175 @@
 * `latLim`: Vector of length = 2, with minimum and maximum latitude coordinates, in decimal degrees, of the bounding box selected. Alternatively, point selection is performed indicating the latitude as a single numeric value. If `NULL` (the default), the whole latitudinal range of the dataset is selected. See details.
 * `level`: Vertical level, if defined for the variable. See details
+* `season`: Optional. A vector of integers specifying the desired season (in months, January=1 ...). Options include one to several months. If `NULL` (the default), the function will return all records within the interval defined by `startDate` and `endDate`. For instance, `season = c(12,1,2)` will retrieve the data series for the standard boreal winter (DJF), period = 6:8 for summer (JJA) and so on. See details.
+* `years`: an integer vector specifying the years to select. Default to all years available in the dataset.
+{{{#!comment
 * `startDate`: Optional character string in the form "Year-month-day" (e.g. `"1950-01-01"`) indicating the starting day of the time series to retrieve. Default to first record available. See details.
 * `endDate`: Optional character string in the form "Year-month-day" (e.g. `"2000-12-31"`) indicating the last day of the time series to retrieve. Default to last record available. See details.
-* `season`: Optional. A vector of integers specifying the desired season (in months, January=1 ...). Options include one to several months. If `NULL` (the default), the function will return all records within the interval defined by `startDate` and `endDate`. For instance, `season = c(12,1,2)` will retrieve the data series for the standard boreal winter (DJF), period = 6:8 for summer (JJA) and so on. See details.
-
-
+}}}
 
 === ''__Details''
@@ -185 +186 @@
 The function can select the whole spatial domain covered by the dataset, spatial windows defined by the minimum and maximum corner coordinates, and single grid-cell values. In the last two cases, the function operates by finding the closest grid-points to the coordinates introduced.
 
-For variables with different vertical levels, only defined level values will be allowed, otherwise getting an error. The function does not look for the closest level to the value introduced, in order to avoid confusions. The function `dataInventory` is useful for finding the valid level values defined for a particular variable.  
-
+For variables with different vertical levels, only defined level values will be allowed, otherwise getting an error. The function does not look for the closest level to the value introduced, in order to avoid confusions. The function `dataInventory` is useful for finding the valid level values defined for a particular variable.
+
+The behavior of the function for year-crossing seasons (e.g. DJF) is similar to `loadSeasonalForecast`.  
+
+{{{#!comment
 In the case of time slice selection in sub-daily datasets, the function will retrieve all records belonging to the days indicated. For instance, if `endDate=2000-12-31` and the dataset has a time resolution of 6h, the last date returned will be ''"2000-12-31 18:00:00"''.
 
 In the case of boreal winter selection (`season=c(12,1,2)`) the function will tie strictly to the time interval defined by the `startDate`and `endDate` arguments, and therefore will not retrieve data from the previous December, nor from the next January and February before/after the start/end years defined (this has a different behaviour than `loadSystem4`, which is more specifically oriented to seasonal forecast data.)
-
+}}}