Skip to content

Commit

Permalink
documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
miturbide committed Jun 23, 2023
1 parent 64263e1 commit 42d7751
Show file tree
Hide file tree
Showing 12 changed files with 80 additions and 31 deletions.
13 changes: 7 additions & 6 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: calibratoR
Depends:
R(>= 3.4.0),
R(>= 3.5.0),
transformeR(>= 1.1.0)
Imports:
stats,
Expand All @@ -10,11 +10,12 @@ Suggests:
loadeR.ECOMS,
visualizeR,
knitr,
rmarkdown
rmarkdown,
climate4R.datasets
Type: Package
Title: An R package for statistical calibration of seasonal climate forecasts
Version: 0.1.1
Date: 2018-06-25
Version: 0.2.0
Date: 2023-06-23
Authors@R: as.person(c(
"Santander Meteorology Group <http://meteo.unican.es> [cph]",
"Rodrigo Manzanas <[email protected]> [aut, cre]",
Expand All @@ -30,7 +31,7 @@ Description: calibratoR (\url{https://github.com/SantanderMetGroup/calibratoR})
which range from simple mean/variance adjustment to more sophisticated Ensemble Model Output Statistics (EMOS) options which take into account the existing correspondence between
the ensemble mean and the observations in the calibration process. It works with the grid object developed for the climate4R bundle (\url{http://www.meteo.unican.es/climate4r}).
Currently, only gridded data are supported (point-wise stations will be also supported in a future release).
License: GPL (>= 3)
License: file LICENSE
LazyData: true
RoxygenNote: 6.0.1
RoxygenNote: 7.1.2
VignetteBuilder: knitr
4 changes: 4 additions & 0 deletions NEWS
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,7 @@
* `calInflation` has been deprecated, replaced by `calCCR` (Climate Conserving Recalibration)
* Replace `print` calls by `message`
* Other minor doc updates

## v0.2.0 (23 Jun 2023)
* Add LICENSE file
* Documentation update
1 change: 1 addition & 0 deletions R/calCCR.R
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
#' @author R. Manzanas and V. Torralba.
#' @examples{
#' ## loading seasonal forecasts (CFS) and observations (NCEP) of boreal winter temperature over Iberia
#' require(climate4R.datasets)
#' data("CFS_Iberia_tas"); fcst = CFS_Iberia_tas
#' data("NCEP_Iberia_tas"); obs = NCEP_Iberia_tas
#' ## passing from daily data to seasonal averages
Expand Down
1 change: 1 addition & 0 deletions R/calLM.R
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
#' @family calibration
#' @examples{
#' ## loading seasonal forecasts (CFS) and observations (NCEP) of boreal winter temperature over Iberia
#' require(climate4R.datasets)
#' data("CFS_Iberia_tas"); fcst = CFS_Iberia_tas
#' data("NCEP_Iberia_tas"); obs = NCEP_Iberia_tas
#' ## passing from daily data to seasonal averages
Expand Down
1 change: 1 addition & 0 deletions R/calMVA.R
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
#' @author R. Manzanas and V. Torralba.
#' @examples{
#' ## loading seasonal forecasts (CFS) and observations (NCEP) of boreal winter temperature over Iberia
#' require(climate4R.datasets)
#' data("CFS_Iberia_tas"); fcst = CFS_Iberia_tas
#' data("NCEP_Iberia_tas"); obs = NCEP_Iberia_tas
#' ## passing from daily data to seasonal averages
Expand Down
2 changes: 1 addition & 1 deletion R/calNGR.R
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
#' @family calibration
#' @examples{
#' ## loading seasonal forecasts (CFS) and observations (NCEP) of boreal winter temperature over Iberia
#' require(transformeR)
#' require(climate4R.datasets)
#' data("CFS_Iberia_tas"); fcst = CFS_Iberia_tas
#' data("NCEP_Iberia_tas"); obs = NCEP_Iberia_tas
#' ## passing from daily data to seasonal averages
Expand Down
1 change: 1 addition & 0 deletions R/calRPC.R
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
#' @family calibration
#' @examples{
#' ## loading seasonal forecasts (CFS) and observations (NCEP) of boreal winter temperature over Iberia
#' require(climate4R.datasets)
#' data("CFS_Iberia_tas"); fcst = CFS_Iberia_tas
#' data("NCEP_Iberia_tas"); obs = NCEP_Iberia_tas
#' ## passing from daily data to seasonal averages
Expand Down
19 changes: 14 additions & 5 deletions man/calCCR.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 14 additions & 5 deletions man/calLM.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 7 additions & 3 deletions man/calMVA.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

21 changes: 15 additions & 6 deletions man/calNGR.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 14 additions & 5 deletions man/calRPC.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 42d7751

Please sign in to comment.