From 91142a631ca8349ebc8b232f2c643f7c7bf9ac0b Mon Sep 17 00:00:00 2001 From: John Helveston Date: Wed, 20 Jan 2021 11:22:35 -0500 Subject: [PATCH] updated readme and license for 0.1.0 cran release --- CRAN-RELEASE | 2 -- LICENSE.md | 2 +- README.Rmd | 16 +++------------- README.md | 20 +++++++++++++------- cran-comments.md | 29 ----------------------------- man/rmdchunks/installation.Rmd | 18 ++++++++++++++++++ 6 files changed, 35 insertions(+), 52 deletions(-) delete mode 100644 CRAN-RELEASE delete mode 100644 cran-comments.md create mode 100644 man/rmdchunks/installation.Rmd diff --git a/CRAN-RELEASE b/CRAN-RELEASE deleted file mode 100644 index a139349a..00000000 --- a/CRAN-RELEASE +++ /dev/null @@ -1,2 +0,0 @@ -This package was submitted to CRAN on 2021-01-15. -Once it is accepted, delete this file and tag the release (commit b1229a4). diff --git a/LICENSE.md b/LICENSE.md index 7dbf3ce4..2f4ea390 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ # MIT License -Copyright (c) 2014-2020 John Paul Helveston +Copyright (c) 2014-2021 John Paul Helveston Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.Rmd b/README.Rmd index 77504f96..06046d07 100644 --- a/README.Rmd +++ b/README.Rmd @@ -25,7 +25,7 @@ status](https://www.r-pkg.org/badges/version/logitr)](https://CRAN.R-project.org [![Travis build status](https://travis-ci.com/jhelvy/logitr.svg?branch=master)](https://travis-ci.com/jhelvy/logitr) -This package estimates multinomial (MNL) and mixed logit (MXL) models in R. Models can be estimated using "Preference" space or "Willingness-to-pay" (WTP) space [utility parameterizations](https://jhelvy.github.io/logitr/articles/utility_models.html). +Estimation of multinomial (MNL) and mixed logit (MXL) models in R with "Preference" space or "Willingness-to-pay" (WTP) space [utility parameterizations](https://jhelvy.github.io/logitr/articles/utility_models.html). The latest version includes support for: @@ -41,20 +41,10 @@ Note: MXL models assume uncorrelated heterogeneity covariances and are estimated ## Installation -The current version is not yet on CRAN, but you can install it from -GitHub using the **devtools** library: - -```{r, eval=FALSE} -devtools::install_github("jhelvy/logitr") -``` - -Load the library with: - -```{r, eval=FALSE} -library(logitr) +```{r child="man/rmdchunks/installation.Rmd"} ``` -## Basic Usage +## Basic Usage View the [basic usage](https://jhelvy.github.io/logitr/articles/basic_usage.html) page for details on how to use **logitr** to estimate models. diff --git a/README.md b/README.md index 68403150..c84d9519 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,8 @@ status](https://www.r-pkg.org/badges/version/logitr)](https://CRAN.R-project.org status](https://travis-ci.com/jhelvy/logitr.svg?branch=master)](https://travis-ci.com/jhelvy/logitr) -This package estimates multinomial (MNL) and mixed logit (MXL) models in -R. Models can be estimated using “Preference” space or -“Willingness-to-pay” (WTP) space [utility +Estimation of multinomial (MNL) and mixed logit (MXL) models in R with +“Preference” space or “Willingness-to-pay” (WTP) space [utility parameterizations](https://jhelvy.github.io/logitr/articles/utility_models.html). The latest version includes support for: @@ -42,11 +41,18 @@ Edition (New York: Cambridge University Press, ## Installation -The current version is not yet on CRAN, but you can install it from -GitHub using the **devtools** library: +You can install {logitr} from CRAN: ``` r -devtools::install_github("jhelvy/logitr") +install.packages("logitr") +``` + +or you can install the development version of {logitr} from +[GitHub](https://github.com/jhelvy/logitr): + +``` r +# install.packages("remotes") +remotes::install_github("jhelvy/logitr") ``` Load the library with: @@ -66,7 +72,7 @@ for details on how to use **logitr** to estimate models. - Author: *John Paul Helveston* [www.jhelvy.com](http://www.jhelvy.com/) - Date First Written: *Sunday, September 28, 2014* -- Most Recent Update: January 14, 2021 +- Most Recent Update: January 20, 2021 - License: [MIT](https://github.com/jhelvy/logitr/blob/master/LICENSE.md) diff --git a/cran-comments.md b/cran-comments.md deleted file mode 100644 index 71f97b92..00000000 --- a/cran-comments.md +++ /dev/null @@ -1,29 +0,0 @@ -## Resubmission -This is a resubmission. In this version I have: - -* Removed the doi notation error from the NEWS.md. -* Reduced the length of the title to less than 65 characters. -* Changed package names in title and description to single quotes, e.g: {nloptr} -> 'nloptr' -* Added a reference in the description with doi to Train (2009) "Discrete Choice Methods with Simulation, 2nd Edition". -* Added \value statements to dummyCode.Rd and statusCodes.Rd. -* Updated \value description for summary.logitr.Rd. -* Modified multiple functions to use message()/warning() instead of print()/cat() -* Added `algorithm` to the `options` input, with the default being set to `"NLOPT_LD_LBFGS"`. - -## Bugs fixed -* Fixed tiny bug in `getParTypes()` function - previously was not returning the correct `parNames` for continuous vs. discrete variables. -* Added an input check to make sure the modelSpace argument is either `"pref"` or `"wtp"`. -* Added an input check to make sure the `priceName` argument is only used when the `modelSpace` argument is set to `"wtp"`. - -## Test environments -* local R installation, R 4.0.2 -* ubuntu 16.04 (on travis-ci), R 4.0.2 -* win-builder (devel) - -## Other notes -Thanks for the recommended changes! This is the first package I've ever submit to CRAN, and I'm still learning best practices. Making these changes actually helped me identify a few small bugs. - -## R CMD check results -0 errors | 0 warnings | 1 notes - -* This is a resubmission. diff --git a/man/rmdchunks/installation.Rmd b/man/rmdchunks/installation.Rmd new file mode 100644 index 00000000..e3d45a90 --- /dev/null +++ b/man/rmdchunks/installation.Rmd @@ -0,0 +1,18 @@ +You can install {logitr} from CRAN: + +```r +install.packages("logitr") +``` + +or you can install the development version of {logitr} from [GitHub](https://github.com/jhelvy/logitr): + +```r +# install.packages("remotes") +remotes::install_github("jhelvy/logitr") +``` + +Load the library with: + +```{r, eval=FALSE} +library(logitr) +```