Changes between Version 10 and Version 11 of EcomsUdg/RPackage/Functions


Ignore:
Timestamp:
May 17, 2013 11:23:57 AM (8 years ago)
Author:
juaco
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • EcomsUdg/RPackage/Functions

    v10 v11  
    1111}}}
    1212
     13''__Arguments__''
     14
     15* `source.dir`: character string indicating a valid path of the directory containing the files
     16* `ncml.file`: character string indicating the NcML file name (and path, default to working directory), including the extension ''.ncml''.
     17
     18The output is a NcML file named as `file.name` which will be stored in the `output.dir`.
     19
    1320''__Details__''
    1421
    1522A NcML file is a [http://en.wikipedia.org/wiki/XML XML] representation of netCDF metadata. This is approximately the same information one gets when dumping the header of a netCDF file (e.g. by typing on the terminal the command `ncdump -h`). By means of NcML it is possible to create virtual datasets by modifying and  aggregating other datasets, thus providing maximum flexibility and ease of access to data stored in collections of files containing data from different variables/time slices. The function `makeNcmlDataset` is intended to deal with reanalysis, forecasts and other climate data products, often consisting of collections of netCDF files corresponding to different variables and partitioned by years/decades or other time slices. It operates by applying to types of [http://www.unidata.ucar.edu/software/netcdf/ncml/v2.2/Aggregation.html aggregation operations]:
    1623
    17 1. `Union`
    18 2. `JoinExisting`
     241. `Union`: Performs the union of all the dimensions, attributes, and variables in multiple NetCDF files
     252. `JoinExisting`: Variables of the same name (in different files) are connected along their existing, outer dimension, called the aggregation dimension. In this case the aggregation dimension is ''time''.
    1926
    2027
    21 * `source.dir`: character string indicating a valid path of the directory containing the files
    22 * `output.dir`: character string indicating a valid path of the directory where the ncml file is to be created. Default to working directory (see details)
    23 * `file.name`: character string indicating the name of the output file, including the extension ".ncml"
    24 
    25 The output is a NcML file named as `file.name` which will be stored in the `output.dir`.
    26 
    27 ''__Details__:''
    2828
    2929* All files of the same dataset should be put together in the same directory, indicated by the `source.dir` argument.
    30 * Currently the function has been only tested for netCDF (.nc) files, although GRIB files will be included in next versions.
    31 * Note that the `output.dir` should be writable in order to create the ncml file.
     30* Currently the function works only with netCDF (''.nc'') file collections.
    3231* A number of useful recommendations regarding dataset naming are provided [http://www.unidata.ucar.edu/software/netcdf-java/reference/DatasetUrls.html#NcmlScan here]
    3332