Changes between Version 16 and Version 17 of EcomsUdg/RPackage/Functions


Ignore:
Timestamp:
May 17, 2013 8:40:42 PM (8 years ago)
Author:
juaco
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • EcomsUdg/RPackage/Functions

    v16 v17  
    1 == makeNcmlDataset ==
     1= makeNcmlDataset =
     2
    23
    34''__Description__''
     
    4243
    4344
    44 == dataInventory ==
     45= dataInventory =
    4546
    4647''__Description__''
     
    8081
    8182
    82 == loadObservations ==
     83= loadObservations =
    8384
    8485''__Description''
     
    121122
    122123
    123 
    124 
    125 
    126 
    127 == loadData ==
     124= loadData =
    128125
    129126''__Description''
    130127
     128Loads selected dimensional slices of a NcML dataset. The function is intended to deal with gridded data (interpolated surfaces, reanalysis ...)
     129
    131130''__Usage''
    132131
     132{{{
     133loadData(dataset, var, standard.vars=FALSE, lonLim=NULL, latLim=NULL, level=NULL, startDate=NULL, endDate=NULL)
     134}}}
     135
    133136''__Arguments''
    134137
     138* `var`: Character string indicating the variable to load.
     139* `standard.vars`: Logical. Default to `FALSE`. If `TRUE` a dictionary must be available (see Details)
     140* `lonLim`: Vector of length = 2, with minimum and maximum longitude coordinates, in decimal degrees, of the bounding box selected.
     141* `latLim`: Vector of length = 2, with minimum and maximum latitude coordinates, in decimal degrees, of the bounding box selected.
     142* `level`: Vertical level, if defined for the variable.
     143* `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.
     144* `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.
     145
    135146''__Details''
    136147
    137148''__Value''
    138149
    139 
    140 
    141 
    142 
    143 == loadSystem4 ==
     150A list with the following components:
     151
     152* `VarName`: name of the variable returned.
     153* `Level`: Vertical level requested. `NULL` if the variable has no vertical levels defined.
     154* `Dates`: A `POSIXlt` class vector of length ''i'' with dates
     155* `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.
     156* `Data`: a 2-D matrix of ''i'' rows x ''j'' columns, of ''i'' forecast times and ''j'' grid-points
     157
     158
     159
     160
     161= loadSystem4 =
    144162
    145163''__Description__''