Changes between Version 36 and Version 37 of EcomsUdg/RPackage/Functions


Ignore:
Timestamp:
May 29, 2013 9:50:48 AM (8 years ago)
Author:
juaco
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • EcomsUdg/RPackage/Functions

    v36 v37  
    119119=== ''__Arguments''
    120120
     121* `dataset`: Character string with the full path to the target ncml file
    121122* `var`: Character string indicating the variable to load.
    122 * `standard.vars`: Logical. Default to `FALSE`. If `TRUE` a dictionary must be available (see Details)
     123* `standard.vars`: Logical. Default to `TRUE`. In this case, a dictionary must be available.
     124* `dictionary`: Character string with the full path to the dictionary. This is used only when `standard.vars = TRUE`. In this case, by default (`dictionary = NULL`), the dictionary is automatically searched in the same directory as the `dataset`, as a file with the same name than the dataset and extension ''.dic''.
    123125* `lonLim`: Vector of length = 2, with minimum and maximum longitude coordinates, in decimal degrees, of the bounding box selected. Alternatively, point selection is performed indicating the longitude as a single numeric value. If `NULL` (the default), the whole longitudinal range of the dataset is selected. See details.
    124126* `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.
    125127* `level`: Vertical level, if defined for the variable. See details
    126 * `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.
     128* `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 for the years selected.
    127129* `years`: an integer vector specifying the years to select. Default to all years available in the dataset.
     130
    128131{{{#!comment
    129 * `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.
    130 * `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.
     132 `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.
     133 `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.
    131134}}}
    132135
     
    153156* `Level`: Vertical level requested. `NULL` if the variable has no vertical levels defined.
    154157* `Dates`: A list with two POSIXlt time elements of length ''i'', corresponding to the rows matrix in `Data`. The list contains two elements:
    155     * Start: Starting times of the verification period of the variable
    156     * End: End time of the verification period of the variable
     158    * `Start`: Starting times of the verification period of the variable
     159    * `End`: End time of the verification period of the variable
    157160* `LatLonCoords`: A 2-D matrix of ''j'' rows (where ''j'' = number of grid points selected) and two columns corresponding to the latitude and longitude coordinates respectively.
    158161* `Data`: a 2-D matrix of ''i'' rows x ''j'' columns, of ''i'' times and ''j'' grid-points