updated readme and license for 0.1.0 cran release

jhelvy · Jan 20, 2021 · 91142a6 · 91142a6
1 parent 58d5725
commit 91142a6
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 52 deletions.
diff --git a/CRAN-RELEASE b/CRAN-RELEASE
diff --git 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
@@ -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)
 <!-- badges: end -->
 
-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
@@ -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)
 <!-- badges: end -->
 
-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
diff --git a/man/rmdchunks/installation.Rmd 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)
+```