Final fixes to vignette, bumped package version, updated ReadMe, DESC…

…RIPTION and NEWS.
IDSIA · May 29, 2024 · b9a0a30 · b9a0a30
1 parent 3c0233e
commit b9a0a30
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 9 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,8 +1,8 @@
 Package: bayesRecon
 Type: Package
-Date: 2023-12-19
+Date: 2024-05-29
 Title: Probabilistic Reconciliation via Conditioning
-Version: 0.2.0
+Version: 0.3.0
 Authors@R: c(person(given = "Dario",
              family = "Azzimonti",
              role = c("aut","cre"),

diff --git a/NEWS.md b/NEWS.md
@@ -1,8 +1,20 @@
+# bayesRecon 0.3.0
+
+* Added `reconc_MixCond`, the implementation of Mixed conditioning for the reconciliation of mixed-type hierarchical forecasts.
+
+* Added `reconc_TDcond`, the implementation of Top-down conditioning for the reconciliation of mixed-type hierarchical forecasts.
+
+* Vignette "Reconciliation of M5 hierarchy with mixed-type forecasts".
+
+* Added functions `PMF.get_mean`, `PMF.get_quantile`, `PMF.get_var`, `PMF.sample`, `PMF.summary` that return point estimates and samples from a probability mass function object.
+
+* Added the dataset `M5_CA1_basefc` which contains the base forecasts for the store "CA1" of the hierarchical time series in the M5 competition. 
+
 # bayesRecon 0.2.0
 
-* Vignette "Properties of the reconciled distribution via conditioning"
+* Vignette "Properties of the reconciled distribution via conditioning".
 
-* Added option in `reconc_BUIS` to pass some base forecast as parameters and some as samples
+* Added option in `reconc_BUIS` to pass some base forecast as parameters and some as samples.
 
 * Added option in `reconc_BUIS` to input a list of distributions instead of a string.
 

diff --git a/README.Rmd b/README.Rmd
@@ -41,7 +41,7 @@ The main functions are:
     multivariate Gaussian and the bottom forecasts are discrete distributions.
 
 ## News
-:boom: [2024-05-24] Added `reconc_MixCond` and `reconc_TDcond`. 
+:boom: [2024-05-29] Added `reconc_MixCond` and `reconc_TDcond` and the vignette "Reconciliation of M5 hierarchy with mixed-type forecasts". 
 
 :boom: [2023-12-19] Added the vignette "Properties of the reconciled distribution via conditioning".
 

diff --git a/README.md b/README.md
@@ -39,7 +39,8 @@ The main functions are:
 
 ## News
 
-:boom: \[2024-05-24\] Added `reconc_MixCond` and `reconc_TDcond`.
+:boom: \[2024-05-29\] Added `reconc_MixCond` and `reconc_TDcond` and the
+vignette “Reconciliation of M5 hierarchy with mixed-type forecasts”.
 
 :boom: \[2023-12-19\] Added the vignette “Properties of the reconciled
 distribution via conditioning”.

diff --git a/man/figures/README-unnamed-chunk-6-1.png b/man/figures/README-unnamed-chunk-6-1.png
diff --git a/man/figures/README-unnamed-chunk-7-1.png b/man/figures/README-unnamed-chunk-7-1.png
diff --git a/vignettes/mixed_reconciliation.Rmd b/vignettes/mixed_reconciliation.Rmd
@@ -1,7 +1,7 @@
 ---
 title: "Reconciliation of M5 hierarchy with mixed-type forecasts"
-author: "Lorenzo Zambon, Dario Azzimonti, Nicolò Rubattu, Giorgio Corani"
-date: "2024-05-22"
+author: "Dario Azzimonti, Lorenzo Zambon, Nicolò Rubattu, Giorgio Corani"
+date: "2024-05-29"
 lang: "en"
 bibliography: references.bib
 output: rmarkdown::html_vignette
@@ -193,6 +193,7 @@ TDCond_time <- as.double(round(difftime(stop, start, units = "secs"), 2))
 cat("Computational time for TD-cond reconciliation: ", TDCond_time, "s")
 ```
 
+
 
 # Comparison
 
@@ -447,7 +448,7 @@ According to RPS, TD-cond does not degrade the bottom base forecasts and improve
 
 # Full reproducibility
 
-The full experiment described in [@zambon2024mixed] can be reproduced by using the code available **here**.
+The full experiment described in [@zambon2024mixed] can be reproduced by using the code available [here](https://github.com/LorenzoZambon/M5_MixedReconc).
 
 # References
 <div id="refs"></div>