From 06482615623d28dd65bfbe2dbf467becd99efaea Mon Sep 17 00:00:00 2001 From: Eva Rifa Date: Wed, 29 Mar 2023 16:05:16 +0200 Subject: [PATCH 1/2] Update README --- NEWS.md | 2 +- README.md | 38 +++++++++++++++++++++----------------- tests/testthat.R | 1 + 3 files changed, 23 insertions(+), 18 deletions(-) diff --git a/NEWS.md b/NEWS.md index 2c634400..e52a7058 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# CSTools 5.0.0 (Release date: 28-03-2023) +# CSTools 5.0.0 (Release date: 30-03-2023) **Fixes** - Correct vignettes: Analogs, MultiModelSkill and MultivarRMSE - Add 'ncores' to s2dv function calls in CST_Anomaly diff --git a/README.md b/README.md index abfc4714..a4bd1a25 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ CSTools ======= +#### Assessing Skill of Climate Forecasts on Seasonal-to-Decadal Timescales + The Climate Services Tools, CSTools, is an easy-to-use R package designed and built to assess and improve the quality of climate forecasts for seasonal to multi–annual scales. The package contains process-based state-of-the-art methods for forecast calibration, bias correction, statistical and stochastic downscaling, optimal forecast combination and multivariate verification, as well as basic and advanced tools to obtain tailored products. This package was developed in the context of the ERA4CS project MEDSCOPE and the H2020 S2S4E project and includes contributions from ArticXchange project founded by EU-PolarNet 2. This GitLab project allows you to monitor its progress and to interact with other developers via the Issues section. @@ -51,30 +53,32 @@ The CSTools package functions can be distributed in the following methods: - **Assessment:** CST_MultiMetric, CST_MultivarRMSE - **Visualization:** PlotCombinedMap, PlotForecastPDF, PlotMostLikelyQuantileMap, PlotPDFsOLE, PlotTriangles4Categories, PlotWeeklyClim. -[CSTools](https://cran.r-project.org/web/packages/CSTools/index.html) package is designed to be compatible with other R packages such as [s2dv](https://cran.r-project.org/web/packages/s2dv/index.html), [startR](https://cran.r-project.org/web/packages/startR/index.html), [CSIndicators](https://cran.r-project.org/web/packages/CSIndicators/index.html), [CSDownscale](https://earth.bsc.es/gitlab/es/csdownscale). Functions with the prefix **CST_** deal with a common object called `s2dv_cube` as inputs. Also, this object can be created from Load (s2dv) and from Start (startR) directly. Multiple functions from different packages can operate on this common data structure to easily define a complete post-processing workflow. +This package is designed to be compatible with other R packages such as [s2dv](https://cran.r-project.org/web/packages/s2dv/index.html), [startR](https://cran.r-project.org/web/packages/startR/index.html), [CSIndicators](https://cran.r-project.org/web/packages/CSIndicators/index.html), [CSDownscale](https://earth.bsc.es/gitlab/es/csdownscale). Functions with the prefix **CST_** deal with a common object called `s2dv_cube` as inputs. Also, this object can be created from Load (s2dv) and from Start (startR) directly. Multiple functions from different packages can operate on this common data structure to easily define a complete post-processing workflow. -The class `s2dv_cube` is mainly a list of named elements to keep data and metadata in a single object. Basic structure of the object class `s2dv_cube`: +The class `s2dv_cube` is mainly a list of named elements to keep data and metadata in a single object. Basic structure of the object: ```r -$data: A multidimensional array -$dims: Dimensions vector -$coords: Named list of coordinates vector - $sdate - $time - $lon +$ data: [data array] +$ dims: [dimensions vector] +$ coords: [List of coordinates vectors] + $ sdate + $ time + $ lon [...] -$attrs: Named list containing the metadata - $Variable - $Datasets - $source_files - $when - $Dates - $load_parameters +$ attrs: [List of the attributes] + $ Variable: + $ varName + $ metadata + $ Datasets + $ Dates + $ source_files + $ when + $ load_parameters ``` -More information about the `s2dv_cube` object class can be found here: [Description of the s2dv_cube object structure document](https://docs.google.com/document/d/1ko37JFl_h6mOjDKM5QSQGikfLBKZq1naL11RkJIwtMM/edit?usp=sharing). +More information about the `s2dv_cube` object class can be found here: [description of the s2dv_cube object structure document](https://docs.google.com/document/d/1ko37JFl_h6mOjDKM5QSQGikfLBKZq1naL11RkJIwtMM/edit?usp=sharing). -The current `s2dv_cube` object (CSTools 5.0.0) differs from the original object (used in CSTools v < 5.0.0). If you have **questions** on this change you can follow some of the points below: +The current `s2dv_cube` object (CSTools 5.0.0) differs from the original object used in the previous versions of the packages. If you have **questions** on this change you can follow some of the points below: - [New s2dv_cube object discussion](https://earth.bsc.es/gitlab/external/cstools/-/issues/94) - [How to deal with the compatibility break](https://earth.bsc.es/gitlab/external/cstools/-/issues/112) diff --git a/tests/testthat.R b/tests/testthat.R index c069d753..557efdc6 100644 --- a/tests/testthat.R +++ b/tests/testthat.R @@ -1,5 +1,6 @@ library(testthat) library(CSTools) +library(startR) test_check("CSTools") -- GitLab From 80b35cb6a5f783dee31ce88ff2e9ff536513bb9b Mon Sep 17 00:00:00 2001 From: Eva Rifa Date: Wed, 29 Mar 2023 16:08:46 +0200 Subject: [PATCH 2/2] Improve README --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a4bd1a25..6f69b5ee 100644 --- a/README.md +++ b/README.md @@ -93,7 +93,6 @@ If you plan on contributing, you should rather clone the project on your worksta The code of each function should live in a separate file with the .R extension under the R folder, and the documentation of each function should live in a separate file with the .Rd extension under the man folder. -For an introductory video on Git, you can have a look at https://vimeo.com/41027679. +For an introductory video on Git, you can have a look at [https://vimeo.com/41027679](https://vimeo.com/41027679). -You can also find all the necessary documentation on git here: https://git-scm.com/book/en/v2 -A lot of it may be a bit complicated for beginners (and not necessary for us), but the "Getting started" and "Git basics" sections are a good resources. +You can also find all the necessary documentation on git here: [https://git-scm.com/book/en/v2](https://git-scm.com/book/en/v2). A lot of it may be a bit complicated for beginners (and not necessary for us), but the "Getting started" and "Git basics" sections are a good resources. -- GitLab