Skip to content

Commit

Permalink
Minor edits to description content, as well as adding .html vignette …
Browse files Browse the repository at this point in the history
…option.
  • Loading branch information
JustinMShea committed Jul 12, 2017
1 parent 0a45939 commit 99c69a9
Show file tree
Hide file tree
Showing 7 changed files with 610 additions and 222 deletions.
2 changes: 0 additions & 2 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,5 @@
^Data Sets- R$
^R data sets for 5e$
^cran-comments.md$
^Farnsworth-EconometricsInR.pdf$
^Jeffrey_M._Wooldridge_Introductory_Econometrics_A_Modern_Approach__2012.pdf$
^appveyor\.yml$
^NEWS\.md$
9 changes: 4 additions & 5 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,12 @@ Description: Economics students new to both Econometrics and R may find the
tasks of learning both a bit daunting. However, if your text is "Introductory
Econometrics: A Modern Approach" by Jeffrey M. Wooldridge, then you are in
luck! The `wooldridge` data package aims to lighten the task by loading any
data set from the text with a single command. In addition, the package contains
data set from the text with a single command. The package contains
documentation for each data set and all data has been efficiently compressed
resulting in a total size that is 62.73% of its original. A wooldridge-vignette
recreates examples from every chapter of the text, offering a relevant
introduction to R's statistical model syntax. Note: Data sets are from the
5th edition (Wooldridge 2013, ISBN-13:978-1-111-53104-1), which is compatible
with all other editions.
provides examples from the text, offering a relevant introduction to R's
econometric modelling syntax. Note: Data sets are from the 5th edition
(Wooldridge 2013, ISBN-13:978-1-111-53104-1), and are compatible with other editions.
Depends: R (>= 3.1.0)
License: GPL-3
Encoding: UTF-8
Expand Down
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,39 @@
[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/wooldridge)](https://cran.r-project.org/package=wooldridge) [![Travis-CI Build Status](https://travis-ci.org/JustinMShea/wooldridge.svg?branch=master)](https://travis-ci.org/JustinMShea/wooldridge) [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/JustinMShea/wooldRidge?branch=master&svg=true)](https://ci.appveyor.com/project/JustinMShea/wooldRidge)


Economics students new to both Econometrics and R may find the tasks of learning both a bit daunting. However, if your text is **"Introductory Econometrics: A Modern Approach"** by Jeffrey M. Wooldridge, then you are in luck!

Economics students new to both Econometrics and R may find the tasks of learning both a bit daunting. However, if your text is **"Introductory Econometrics: A Modern Approach"** by Jeffrey M. Wooldridge, then you are in luck! The `wooldridge` data package aims to lighten the task by loading any data set from the text with a single command.
The `wooldridge` data package aims to lighten the task by loading any data set from the text with a single command. The package contains documentation for each data set and all data has been efficiently compressed resulting in a total size that is **62.73%** of its original. Just install the package, load it, and call the data set you need to work with.

In addition the package contains documentation for each data set and all data has been efficiently compressed resulting in a total size that is **62.73%** of its original size. Just install the package, load it, and call the data set you need to work with.
_**But wait...there's more!**_ Act now (or at anytime) and you will receive the :sparkles: [`wooldridge-vignette`](https://github.com/JustinMShea/wooldridge/tree/master/vignettes/wooldridge-vignette.pdf).:sparkles: The vignette illustrates how to recreate examples provided in the text, offering a relevant introduction to getting started with R's econometric modelling syntax.

_**But wait...there's more!**_ Contained in the package is also the [`wooldridge-vignette`](https://github.com/JustinMShea/wooldridge/tree/master/vignettes/wooldridge-vignette.pdf), which shows you how to recreate examples from every chapter of the text,
offering a relevant introduction to R's statistical model syntax.
While the course companion site also provides publicly available data sets for E-views, Excel, MiniTab, and Stata commercial software products, **R** is an open source option. Furthermore, taking the step to use R while building a foundation in Econometrics, offers the curious Student a gateway to accessing advanced topics available in the R package ecosystem.


**Note:** All data sets are from the 5th edition (Wooldridge 2013, `ISBN-13:978-1-111-53104-1`), which is compatible with most other editions.
**Note:** All data sets are from the 5th edition (Wooldridge 2013, `ISBN-13: 978-1-111-53104-1`), which is compatible with most other editions.


## Installation

If you don't already have `devtools` installed, try the `ghit` package, a lightweight github installer.
Install directly from CRAN, which depends on R version >= 3.4.0.

```{r}
install.packages("wooldridge")
```

For developer version (with dependencies relaxed to R version >= 3.1.0),
install from GitHub.

```{r}
install.packages("ghit")
devtools::install_github("JustinMShea/wooldridge")
```

Next, install 'wooldridge' package from my GitHub page.
Or:

```{r}
ghit::install_github("JustinMShea/wooldridge")
devtools::install_github("JustinMShea/wooldridge", build_vignettes = TRUE)
```


## Example

Load the `wooldridge` package and use the `data()` function to load the desired set.
Expand All @@ -42,7 +49,7 @@ Check out the documentation on the variable column names and what they are.
?jtrain
```

In addition, load the [`wooldridge-vignette`](https://github.com/JustinMShea/wooldridge/tree/master/vignettes/wooldridge-vignette.pdf) for a recreation of examples from the text.
In addition, load [`wooldridge-vignette`](https://github.com/JustinMShea/wooldridge/tree/master/vignettes/wooldridge-vignette.pdf) for a recreation of examples from the text.

```{r}
vignette("wooldridge-vignette")
Expand Down
9 changes: 4 additions & 5 deletions data-raw/final_roxy_build_delete.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,16 @@
# time to roxygenize those .R description files we wrote!
devtools::document()

# Build vignette
devtools::build_vignettes()
# Build package
devtools::build()

# delete Building vignette folder as it creates build warning.
unlink("inst/doc", recursive = TRUE)
unlink("inst", recursive = TRUE)

# Render .pdf vignette
# Render .pdf and .html vignettes
library(rmarkdown)
rmarkdown::render("vignettes/wooldridge-vignette.Rmd", pdf_document(toc=TRUE))

rmarkdown::render("vignettes/wooldridge-vignette.Rmd", "all")

# build checks
use_travis()
Expand Down
Loading

0 comments on commit 99c69a9

Please sign in to comment.