doco updates

CONTRIBUTING.md

@@ -0,0 +1,23 @@
+Contributions to **eeptools** are welcome from anyone and are best sent as pull requests on [the GitHub repository](https://github.com/jknowles/eeptools/). This page provides some instructions to potential contributors about how to add to the package.
+
+ 1. Contributions can be submitted as [a pull request](https://help.github.com/articles/creating-a-pull-request/) on GitHub by forking or cloning the [repo](https://github.com/leeper/rio/), making changes and submitting the pull request.
+
+ 2. Pull requests should involve only one commit per substantive change. This means if you change multiple files (e.g., code and documentation), these changes should be committed together. If you don't know how to do this (e.g., you are making changes in the GitHub web interface) just submit anyway and the maintainer will clean things up.
+
+ 3. All contributions must be submitted consistent with the package license ([GPL-3](http://www.gnu.org/licenses/old-licenses/gpl-3.0.en.html)).
+
+ 4. All contributions need to be noted in the `Authors@R` field in the [DESCRIPTION](https://github.com/jknowles/eeptools/blob/master/DESCRIPTION). Just follow the format of the existing entries to add your name (and, optionally, email address). Substantial contributions should also be noted in [`inst/CITATION`](https://github.com/jknowles/eeptools/blob/master/inst/CITATION).
+
+ 5. This package uses royxgen code and documentation markup, so changes should be made to roxygen comments in the source code `.R` files. If changes are made, roxygen needs to be run. The easiest way to do this is a command line call to: `Rscript -e devtools::document()`. Please resolve any roxygen errors before submitting a pull request.
+
+ 6. Please run `R CMD BUILD eeptools` and `R CMD CHECK eeptools_VERSION.tar.gz` before submitting the pull request to check for any errors.
+
+Some specific types of changes that you might make are:
+
+ 1. Documentation-only changes (e.g., to Rd files, README, vignettes). This is great! All contributions are welcome.
+
+ 2. Changes requiring a new package dependency should be discussed on the GitHub issues page before submitting a pull request.
+
+ 3. Message translations. These are very appreciated! The format is a pain, but if you're doing this I'm assuming you're already familiar with it.
+
+Any questions you have can be opened as GitHub issues or directed to jknowles (at) gmail.com.

NEWS.md

@@ -2,6 +2,10 @@
 
 ## eeptools 1.1.0
 
+### Added
+A CONTRIBUTING.md file modeled after the excellent example in the `rio` package 
+by @leeper
+
 ### Bug fixes
 - Fix compatibiltiy issue for `leading_zero` function with latest version of R
 

R/eeptools.R

@@ -1,7 +1,7 @@
 .onAttach<-function(...){
   if (!interactive() ) return()
-packageStartupMessage("Welcome to eeptools for R version 0.9.1!", appendLF=TRUE)
-packageStartupMessage("Developed by Jared E. Knowles 2012-2015", appendLF=TRUE)
+packageStartupMessage("Welcome to eeptools for R version 1.1.0!", appendLF=TRUE)
+packageStartupMessage("Developed by Jared E. Knowles 2012-2017", appendLF=TRUE)
 packageStartupMessage("for the Wisconsin Department of Public Instruction", appendLF=TRUE)
 packageStartupMessage("Distributed without warranty.", appendLF=TRUE)
 

README.Rmd

@@ -194,25 +194,6 @@ head(sim.results)
 ```
 
 
-# Plotting Themes
-
-The package includes a number of themes for `ggplot2` named `theme_dpi` to reflect 
-their internal use at the Wisconsin Department of Public Instruction. These themes 
-are very similar to the `theme_bw()` within `ggplot2` but with font sizes optimized 
-for presentations and publications. 
-
-```{r map}
-crimes <- data.frame(state = tolower(rownames(USArrests)), USArrests)
-require(reshape) # for melt
-crimesm <- melt(crimes, id = 1)
-states_map <- map_data("state")
-p1 <- ggplot(crimes, aes(map_id = state)) + geom_map(aes(fill = Murder), 
-                                                     linetype = 1, map = states_map) + 
-       expand_limits(x = states_map$long, y = states_map$lat) + labs(title="USA Crime")
-p1 <- p1 + coord_map()
-p1 + theme_dpi_map()
-```
-
 There is also a `ggplot2` version of `plot.lm` included:
 
 ```{r lmautoplot}
@@ -232,11 +213,14 @@ crosstabplot(sampDat, "y", "fac", varnames = varnames,  label = TRUE,
              title = "Crosstab Plot", shade = FALSE)
 ```
 
-
-
 # Helping Out
 
+Review the [Contributor Guide](CONTRIBUTING.md) for specific directions and tips 
+on how to get involved.
+
 `eeptools` is intended to be a useful project for the education analytics 
-community. Contributions are welcomed. Please note that this project is released with a 
+community. Contributions are welcomed. Please note that this project is 
+released with a 
 [Contributor Code of Conduct](CONDUCT.md). By participating in this project you 
-agree to abide by its terms. 
+agree to abide by its terms.
+

README.md

@@ -13,9 +13,7 @@ Datasets
 
 ``` r
 library(eeptools)
-#> Warning: package 'eeptools' was built under R version 3.3.2
 #> Loading required package: ggplot2
-#> Warning: package 'ggplot2' was built under R version 3.3.2
 data("stuatt")
 head(stuatt)
 #>   sid school_year male race_ethnicity birth_date
@@ -240,29 +238,6 @@ head(sim.results)
 #> 6 -1.5     1 -0.32213552 -7.343319 6.737021
 ```
 
-Plotting Themes
-===============
-
-The package includes a number of themes for `ggplot2` named `theme_dpi` to reflect their internal use at the Wisconsin Department of Public Instruction. These themes are very similar to the `theme_bw()` within `ggplot2` but with font sizes optimized for presentations and publications.
-
-``` r
-crimes <- data.frame(state = tolower(rownames(USArrests)), USArrests)
-require(reshape) # for melt
-#> Loading required package: reshape
-crimesm <- melt(crimes, id = 1)
-states_map <- map_data("state")
-p1 <- ggplot(crimes, aes(map_id = state)) + geom_map(aes(fill = Murder), 
-                                                     linetype = 1, map = states_map) + 
-       expand_limits(x = states_map$long, y = states_map$lat) + labs(title="USA Crime")
-p1 <- p1 + coord_map()
-p1 + theme_dpi_map()
-#> Warning: 'theme_dpi_map' is deprecated.
-#> Use 'theme_bw' instead.
-#> See help("Deprecated")
-```
-
-![](tools/readme/README-map-1.png)
-
 There is also a `ggplot2` version of `plot.lm` included:
 
 ``` r
@@ -289,4 +264,6 @@ crosstabplot(sampDat, "y", "fac", varnames = varnames,  label = TRUE,
 Helping Out
 ===========
 
+Review the [Contributor Guide](CONTRIBUTING.md) for specific directions and tips on how to get involved.
+
 `eeptools` is intended to be a useful project for the education analytics community. Contributions are welcomed. Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.