Merge pull request #15 from epiforecasts/rename

rename to qrensemble

Author: sbfnk

DESCRIPTION

@@ -1,6 +1,6 @@
-Package: qra
-Title: Quantile Regression Average
-Version: 0.1.1.9000
+Package: qrensemble
+Title: Forecast ensembles using Quantile Regression Average (QRA)
+Version: 0.1.2
 Authors@R: 
     c(person(given = "Sebastian",
              family = "Funk",

NEWS.md

@@ -1,10 +1,12 @@
-# qra (development version)
+# qrensemble 0.1.2
+
+- The package was renamed to qrensemble to avoid a conflict with the existing qra package on CRAN
 
 # qra 0.1.1
 
 - Fixed missing purrr import
 
 # qra 0.1.0
 
-This is the initial release of qra.
+This is the initial release of qrensemble.
 

README.Rmd

@@ -7,26 +7,23 @@ output: github_document
 NB: This is a transient package that will probably be merged into the
 [stackr package](https://github.com/nikosbosse/stackr). 
 
-## Prerequisites
-
-This depends on the [scoringutils](https://github.com/epiforecasts/scoringutils)
-package, which can be installed with 
+## Installation
 
+The stable version of the package can be installed using
 ```{r eval=FALSE}
-remotes::install_github("epiforecasts/scoringutils")
+install.packages("qrensemble", repos = "https://epiforecasts.r-universe.dev/")
 ```
 
-The code itself can be tested by installing the corresponding package:
+The development version can be installed using `pak`
 ```{r eval=FALSE}
-remotes::install_github("epiforecasts/qra")
+pak::pak("epiforecasts/qrensemble")
 ```
 
 ### calculate QRA
 
 Create an ensemble for each location, and separately for cases and deaths, for the 24th of July 2021
 ```{r}
-library("scoringutils")
-example_quantile |>
+scoringutils::example_quantile |>
   as_forecast_quantile() |>
   qra(
     group = c("target_type", "location", "location_name"),

vignettes/qra.Rmd vignettes/qrensemble.Rmdvignettes/qra.Rmd renamed to vignettes/qrensemble.Rmd

@@ -1,18 +1,18 @@
 ---
-title: "Getting started with `qra`"
+title: "Getting started with `qrensemble`"
 output:
   rmarkdown::html_vignette:
     toc: false
     number_sections: false
 bibliography: library.bib
 csl: https://raw.githubusercontent.com/citation-style-language/styles/master/apa-numeric-superscript-brackets.csl
 vignette: >
-  %\VignetteIndexEntry{Getting started with qra}
+  %\VignetteIndexEntry{Getting started with qrensemble}
   %\VignetteEngine{knitr::rmarkdown}
   %\VignetteEncoding{UTF-8}
 ---
 
-The `qra` package can be used to train ensemble models from forecasts given in quantile format. It uses the [quantgen](ryantibs) package for the underlying optimisation.
+The `qrensemble` package can be used to train ensemble models from forecasts given in quantile format. It uses the [quantgen](ryantibs) package for the underlying optimisation.
 
 It works with data frames of forecasts and data, similar to the ones used in the [scoringutils](https://epiforecasts.io/scoringutils) package. The outputs it produces are in the same format.