Changes between Version 20 and Version 21 of EcomsUdg/RPackage/Functions


Ignore:
Timestamp:
May 20, 2013 1:08:41 PM (8 years ago)
Author:
juaco
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • EcomsUdg/RPackage/Functions

    v20 v21  
    143143* `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.
    144144* `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.
    145 * `season`:
     145* `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, period = 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.
     146
    146147
    147148''__Details''
     
    149150The 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.
    150151
    151 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 `datasetInventory` is useful for finding out the valid level values defined for a particular variable. 
     152For 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. 
    152153
    153154In 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"''.
     155
     156In 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.)
     157
    154158
    155159''__Value''