... | ... | @@ -10,9 +10,8 @@ It allows you to load a variable from one or more experiments together with the |
|
|
If you want to keep abreast of the latest releases, bugs and discussions on s2dverification, subscribe to its mailing list by sending an e-mail to s2dverification-request@bsc.es with the subject 'subscribe'.
|
|
|
|
|
|
#### How to cite
|
|
|
[Main publication] (http://ieeexplore.ieee.org/document/7568429/) ([pdf] (https://earth.bsc.es/wiki/lib/exe/fetch.php?media=publications:dmanubens_hpcs_2016.pdf))
|
|
|
|
|
|
* N. Manubens et al., “An R Package for Climate Forecast Verification,” Environmental Modelling and Software 2018 (under review)
|
|
|
* N. Manubens et al., “An R Package for Climate Forecast Verification,” Environmental Modelling and Software 2018 (under review).
|
|
|
|
|
|
#### Contact persons
|
|
|
Code developed by [Barcelona Supercomputing Centre] (https://www.bsc.es/) (BSC-CNS).
|
... | ... | @@ -27,7 +26,22 @@ Developers: |
|
|
#### [User guide](user_guide)
|
|
|
#### [Change log] (change_log)
|
|
|
#### [User manual] (user_manual)
|
|
|
[Manual]([pdf] (https://cran.r-project.org/web/packages/s2dverification/s2dverification.pdf))
|
|
|
The user manual can be downloaded from [CRAN]([pdf] (https://cran.r-project.org/web/packages/s2dverification/s2dverification.pdf)).
|
|
|
|
|
|
#### [Dissemination] (disemination)
|
|
|
#### [Development] (development)
|
|
|
|
|
|
### Package structure
|
|
|
|
|
|
|
|
|
In the 's2dverification' project main folder you can see a few files that fulfil the standard R package structure. These files are called the source files. The structure is as follows:
|
|
|
|
|
|
- Folder 'R': Contains .R files with the code of the functions in the package, one function per file. The name of the file must be the same as the function it contains ending with '.R'.
|
|
|
|
|
|
- Folder 'man': Contains .Rd files with the documentation of the functions and of the package, one file per function and one file for the documentation of the whole package. The name of the file must be the same as the function, ending with '.Rd'. This file should contain a section named 'examples' than contains example code that calls the function being documented.
|
|
|
|
|
|
- Folder 'inst': Contains documentation files, images, etc. that will be provided to the user after the installation of the package. Be careful with the weight of the files, they should be as light as possible. For example, the folder 'inst/doc' contains demo scripts that show how to use the package. When the user installs the package, they will be able to check the scripts in the folder '/path/to/package/doc'. This folder also contains the folder 'config' which contains two s2dverification configuration files, one used at IC3 and which is loaded by default, and a sample configuration file.
|
|
|
|
|
|
- File 'DESCRIPTION': Contains general information about the package, dependencies, authorship, etc. and is looked up automatically in the package build stage.
|
|
|
|
|
|
- File 'NAMESPACE': Specifies what variable names are used from outside the package and what variable names are provided to the outside. |