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


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

--

Legend:

Unmodified
Added
Removed
Modified
  • EcomsUdg/RPackage/Functions

    v11 v12  
    3131* A number of useful recommendations regarding dataset naming are provided [http://www.unidata.ucar.edu/software/netcdf-java/reference/DatasetUrls.html#NcmlScan here]
    3232
    33 '''__2. dataInventory.R__'''
     33== dataInventory ==
    3434
    35 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 meta-data components summarizing the main characteristics of the selected dataset. Note that his function provides an overview of the data as they are stored in the original data files. The characteristics of the loaded data after using any of the functions for data access (e.g., `loadSystem4.R`) may change (for instance, after data transformation temperature may be provided in ºC instead of the originally stored K, and so on).
     35''__Description__''
    3636
    37 The function is called in the following way:
     37Provides summary information about the main characteristics of a NcML dataset.
     38
     39''__Usage__''
    3840
    3941{{{
    40 > dataInventory(dataset, print.summary = TRUE)
     42dataInventory(dataset)
    4143}}}
    4244
    43 The arguments are next described:
    4445
    45 * `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]).
    46 * `print.summary`: logical flag indicating if a summary table is printed on screen, in addition to the output list. Default to `TRUE`.
     46''__Arguments__''
     47
     48* `dataset`: a character string indicating the full path to the virtual dataset (the `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]).
     49
     50
     51''__Details__''
     52
     53A common user's need prior to data analysis, is to get an overview of all data available and their structure (variables, dimensions, units, geographical extent, time span ...). The function provides an overview of the raw data as they are stored in the original data files. The characteristics of the loaded data after using any of the functions for data access (e.g., `loadSystem4.R`) may change (for instance, after data transformation temperature may be provided in ºC instead of the originally stored K, and so on).
     54
    4755
    4856The output of the function consists of a list of variable length, depending on the number of variables contained in the dataset, following this structure: