Changes between Version 33 and Version 34 of EcomsUdg/RPackage/Functions

Timestamp:

May 28, 2013 7:27:16 PM (9 years ago)

Author:

gutierjm

Comment:

--

EcomsUdg/RPackage/Functions

@@ -1 @@
-= makeNcmlDataset =
-
-
-
-=== ''__Description''
-
-Generates a NcML file from a collection of netCDF files.
-
-
-=== ''__Usage''
-
-{{{
-makeNcmlDataset(source.dir, ncml.file) 
-}}}
-
-
-=== ''__Arguments''
-
-* `source.dir`: character string indicating a valid path of the directory containing the files
-* `ncml.file`: character string indicating the NcML file name (and path, default to working directory), including the extension ''.ncml''. 
-
-The output is a NcML file named as `file.name` which will be stored in the `output.dir`. 
-
-
-=== ''__Details''
-
-* All files of the same dataset should be put together in the same directory, indicated by the `source.dir` argument.
-* Currently the function works only with netCDF (''.nc'') file collections.
-* A number of useful recommendations regarding dataset naming are provided [http://www.unidata.ucar.edu/software/netcdf-java/reference/DatasetUrls.html#NcmlScan here]
-
-
-=== ''__Value''
-
-Creates a NcML file at the specified location
-
-=== ''__Notes''
-
-A 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]:
-
-1. `Union`: Performs the union of all the dimensions, attributes, and variables in multiple NetCDF files 
-2. `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''.
-
-
-=== ''__Examples'' ===
-
-An example of this function is provided in the [wiki:SpecsEuporias/RPackage/Examples#loadSeasonalForecast Examples section]
-
-
-
-
-
 = dataInventory =
 
@@ -91 +40 @@
 === ''__Examples__''
 
-An example of this function is provided in the [wiki:SpecsEuporias/RPackage/Examples Examples section]
+An example of this function is provided in the [wiki:SpecsEuporias/RPackage/Examples#dataInventory Examples section]
 
 
@@ -282 +231 @@
 An example of this function is provided in the [wiki:SpecsEuporias/RPackage/Examples Examples section]
 
-
-
-
+= makeNcmlDataset =
+
+
+
+=== ''__Description''
+
+Generates a NcML file from a collection of netCDF files.
+
+
+=== ''__Usage''
+
+{{{
+makeNcmlDataset(source.dir, ncml.file) 
+}}}
+
+
+=== ''__Arguments''
+
+* `source.dir`: character string indicating a valid path of the directory containing the files
+* `ncml.file`: character string indicating the NcML file name (and path, default to working directory), including the extension ''.ncml''. 
+
+The output is a NcML file named as `file.name` which will be stored in the `output.dir`. 
+
+
+=== ''__Details''
+
+* All files of the same dataset should be put together in the same directory, indicated by the `source.dir` argument.
+* Currently the function works only with netCDF (''.nc'') file collections.
+* A number of useful recommendations regarding dataset naming are provided [http://www.unidata.ucar.edu/software/netcdf-java/reference/DatasetUrls.html#NcmlScan here]
+
+
+=== ''__Value''
+
+Creates a NcML file at the specified location
+
+=== ''__Notes''
+
+A 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]:
+
+1. `Union`: Performs the union of all the dimensions, attributes, and variables in multiple NetCDF files 
+2. `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''.
+
+
+=== ''__Examples'' ===
+
+An example of this function is provided in the [wiki:SpecsEuporias/RPackage/Examples#loadSeasonalForecast Examples section]
+
+
+
+
+
+
+
+