Finalise FRED-QD update, close #35

nk027 · Sep 10, 2019 · 3ef7473 · 3ef7473
1 parent 58b199e
commit 3ef7473
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 17 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: BVAR
 Type: Package
 Title: Hierarchical Bayesian Vector Autoregression
-Version: 0.2.0.9000
+Version: 0.2.1
 Date: 2019-09-05
 Authors@R: c(person("Nikolas", "Kuschnig", role = c("aut", "cre"), email = "nikolas.kuschnig@wu.ac.at"),
     person("Lukas", "Vashold", role = "aut"),
@@ -19,7 +19,7 @@ URL: https://github.com/nk027/bvar
 BugReports: https://github.com/nk027/bvar/issues
 Depends: R (>= 3.3.0)
 Imports: mvtnorm, stats, graphics, utils
-Suggests: vars, coda
+Suggests: coda, vars
 License: GPL-3 | file LICENSE
 Encoding: UTF-8
 LazyData: true

diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,13 @@
+# v0.2.1, CRAN Update 3 / FRED-QD ODC-BY 1.0
+
+- Clarify exact ToU of the FRED-QD dataset with St. Louis Fed
+- Comply with the new modified ODC-BY 1.0 for FRED-QD
+  - Mention and add license to LICENSE file (linked in DESCRIPTION)
+  - Add copyrighted series for which we have permission to use
+  - Mention updates and license in the data documentation
+- Fix and improve documentation
+
+
 # v0.2.0, CRAN Update 2 / JSS Revision 1
 
 - Extend methods further

diff --git a/R/data.R b/R/data.R
@@ -5,18 +5,20 @@
 #' Channels of the 2007-2009 Recession" by Stock and Watson (2012),
 #' but also contains several additional series.
 #' The currently included dataset is from April 2019, contains observations
-#' from 1959Q1 until 2018Q4, and has been subset to series that are
-#' in public domain.
+#' from 1959Q1 until 2018Q4, and has been subset to series that either are
+#' in public domain, or we were given permission to use.
 #'
 #' For further details see McCracken and Ng (2016) or the dataset's appendix at
 #' \url{https://research.stlouisfed.org/econ/mccracken/fred-databases/}.
+#' The FRED-QD database is made available under a modified ODC-BY 1.0 license,
+#' which can be found in the provided \emph{LICENSE} file.
 #' Thanks to Michael McCracken, Adrienne Brennecke and the Federal Reserve
-#' Bank of St. Louis the FRED-QD database is made available under a modified
-#' ODC-BY 1.0 licence, which can be found in the provided \emph{LICENSE} file.
+#' Bank of St. Louis for making this database available and their
+#' responsiveness and help regarding licensing issues.
 #'
 #' @docType data
 #'
-#' @format A \code{data.frame} with 240 observations of 203 (248) variables.
+#' @format A \code{data.frame} with 240 observations of 234 (248) variables.
 #'
 #' @keywords dataset FRED macroeconomics
 #'

diff --git a/cran-comments.md b/cran-comments.md
@@ -1,3 +1,13 @@
+# v0.2.1, CRAN Update 3 / FRED-QD ODC-BY 1.0
+
+- Clarify exact ToU of the FRED-QD dataset with St. Louis Fed
+- Comply with the new modified ODC-BY 1.0 for FRED-QD
+  - Mention and add license to LICENSE file (linked in DESCRIPTION)
+  - Add copyrighted series for which we have permission to use
+  - Mention updates and license in the data documentation
+- Fix and improve documentation
+
+
 # v0.2.0, CRAN Update 2 / JSS Revision 1
 
 - Extend methods further

diff --git a/man/fred_qd.Rd b/man/fred_qd.Rd
diff --git a/scripts/replication_script.R b/scripts/replication_script.R
@@ -5,7 +5,7 @@
 
 # Preliminaries -----------------------------------------------------------
 
-install.packages("BVAR") # Version 0.2.0
+install.packages("BVAR") # Version 0.2.1
 
 set.seed(42)
 library("BVAR")