From f37872f60a5bd52718a8668a3d5343468a95d967 Mon Sep 17 00:00:00 2001 From: John Helveston Date: Thu, 16 Jun 2022 14:27:40 -0400 Subject: [PATCH 1/5] Update NEWS.md --- NEWS.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/NEWS.md b/NEWS.md index ed092768..9bf48612 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,13 @@ +# logitr 0.7.0 + +- A new vignette on benchmarking was added which tests the package speed against other similar packages. +- A new data set, `runtimes`, was included, which is exported from the colab notebook used for benchmarking here: https://colab.research.google.com/drive/1vYlBdJd4xCV43UwJ33XXpO3Ys8xWkuxx?usp=sharing +- Sobol draws are supported via a new `drawType` argument. +- A warning is displayed against using Halton draws after 5 random variables have been specified in a mixed logit model. Users are encouraged to switch to using Sobol draws and increasing the number of draws to at least 200. +- Changed the argument name `price` to `scalePar` to be more general. +- Changed the argument name `randPrice` to `randScale` to be more general. +- The `modelSpace` argument is no longer required for specifying a WTP space model as it is redundant. Including a `scalePar` argument is enough to determine that it is a WTP space model. + # logitr 0.6.1 - Fixes error on some of the gradient tests from 0.6.0 release. The gradient tests were sensitive to the random starting parameters, so I modified how the starting parameters were set for the first iteration of a multistart loop such that they would be more consistent. From 1d23414181044b3438de738a56505b4005cb5e26 Mon Sep 17 00:00:00 2001 From: John Helveston Date: Thu, 16 Jun 2022 14:30:19 -0400 Subject: [PATCH 2/5] update readme --- README.md | 12 ++---------- inst/CITATION | 4 ++-- 2 files changed, 4 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 1dbbcd60..aa5a11e2 100644 --- a/README.md +++ b/README.md @@ -66,14 +66,6 @@ View the [basic usage](https://jhelvy.github.io/logitr/articles/basic_usage.html) page for details on how to use **logitr** to estimate models. -## Related software - -If you are a Python user, [`xlogit`](https://github.com/arteagac/xlogit) -is a similar package built in Python. It has a similar user interface -for defining models, and it is even faster than logitr as it uses -GPU-accelerated estimation for mixed logit models. It is a good resource -for comparing results with those from logitr. - ## Author, Version, and License Information - Author: *John Paul Helveston* @@ -94,7 +86,7 @@ citation("logitr") #> #> John Paul Helveston (2022). logitr: Fast Estimation of Multinomial #> and Mixed Logit Models with Preference Space and Willingness to Pay -#> Space Utility Parameterizations. R package version 0.6.1 +#> Space Utility Parameterizations. #> #> A BibTeX entry for LaTeX users is #> @@ -102,7 +94,7 @@ citation("logitr") #> title = {logitr: Fast Estimation of Multinomial and Mixed Logit Models with Preference Space and Willingness to Pay Space Utility Parameterizations}, #> author = {John Paul Helveston}, #> year = {2022}, -#> note = {R package version 0.6.1}, +#> note = {R package}, #> url = {https://jhelvy.github.io/logitr/}, #> } ``` diff --git a/inst/CITATION b/inst/CITATION index 1324ee59..1b2abfe4 100644 --- a/inst/CITATION +++ b/inst/CITATION @@ -5,7 +5,7 @@ citEntry( title = "logitr: Fast Estimation of Multinomial and Mixed Logit Models with Preference Space and Willingness to Pay Space Utility Parameterizations", author = "John Paul Helveston", year = "2022", - note = "R package version 0.6.1", + note = "R package", url = "https://jhelvy.github.io/logitr/", - textVersion = "John Paul Helveston (2022). logitr: Fast Estimation of Multinomial and Mixed Logit Models with Preference Space and Willingness to Pay Space Utility Parameterizations. R package version 0.6.1" + textVersion = "John Paul Helveston (2022). logitr: Fast Estimation of Multinomial and Mixed Logit Models with Preference Space and Willingness to Pay Space Utility Parameterizations." ) From 69763f7a917de7d97844ff3acb9f7f2cded7ddde Mon Sep 17 00:00:00 2001 From: John Helveston Date: Thu, 16 Jun 2022 14:34:16 -0400 Subject: [PATCH 3/5] Increment version number --- DESCRIPTION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index 6bcc5a57..3fbd2cf8 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: logitr Title: Logit Models w/Preference & WTP Space Utility Parameterizations -Version: 0.6.1 +Version: 0.7.0 Authors@R: c( person(given = "John", family = "Helveston", From f56b55c9ff78690096fc60567275b6424491f403 Mon Sep 17 00:00:00 2001 From: John Helveston Date: Thu, 16 Jun 2022 16:08:57 -0400 Subject: [PATCH 4/5] Update cran-comments.md --- cran-comments.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/cran-comments.md b/cran-comments.md index f814681b..4e31d7e0 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -7,4 +7,5 @@ 0 errors | 0 warnings | 0 notes ## Notes -* This is a new release +* This is a new release. +* Apologies for another release so soon (it's been a productive week) - this will be the last for at least a month or longer. From cc418e801e351e9a1eb698937ae93df591e9504c Mon Sep 17 00:00:00 2001 From: John Helveston Date: Thu, 16 Jun 2022 17:43:53 -0400 Subject: [PATCH 5/5] Create CRAN-RELEASE --- CRAN-RELEASE | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 CRAN-RELEASE diff --git a/CRAN-RELEASE b/CRAN-RELEASE new file mode 100644 index 00000000..4ebdc72e --- /dev/null +++ b/CRAN-RELEASE @@ -0,0 +1,2 @@ +This package was submitted to CRAN on 2022-06-16. +Once it is accepted, delete this file and tag the release (commit f56b55c).