| 1 | * '''__dataInventory.R__''' |
| 2 | |
| 3 | Prior to data analysis, a common need is to have an overview of all data available and their structure (variables, dimensions, units, geographical extent, time span ...). The function `dataInventory.R` is intended to perform this task, returning a list of components summarizing the main characteristics of the selected dataset. The function is called in the following way: |
| 4 | |
| 5 | {{{ |
| 6 | dataInventory(dataset, print.summary = TRUE) |
| 7 | }}} |
| 8 | |
| 9 | The arguments are next described: |
| 10 | |
| 11 | * `dataset`: a character string indicating the full path to the virtual dataset (a `ncml` file). This can be either a path containing the directory and name of the file, or an appropriate URL in case the dataset is remotely accessed (e.g., via the [https://www.meteo.unican.es/trac/meteo/wiki/SpecsEuporias/DataServer/THREDDS SPECS-EUPORIAS THREDDS]). |
| 12 | * `print.summary`: logical flag indicating if a summary table is printed on screen, in addition to the output list. |
| 13 | |
| 14 | The output of the function consists of a list of variable length depending on the number of variables contained in the dataset, following this structure: |
| 15 | |
| 16 | * `Name of the variable` |
| 17 | * `Description` |
| 18 | * `Name` |
| 19 | |
| 20 | |
| 21 | * '''__loadSystem4.R__''' |
| 22 | |