Update README

.Rbuildignore

@@ -6,3 +6,4 @@
 ^NOTES\.*md$
 ^NOTES\.*html$
 ^README_files
+^CONDUCT\.md$

CONDUCT.md

@@ -0,0 +1,25 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who 
+contribute through reporting issues, posting feature requests, updating documentation,
+submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for
+everyone, regardless of level of experience, gender, gender identity and expression,
+sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or
+imagery, derogatory comments or personal attacks, trolling, public or private harassment,
+insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments,
+commits, code, wiki edits, issues, and other contributions that are not aligned to this 
+Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed 
+from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by 
+opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the Contributor Covenant 
+(http:contributor-covenant.org), version 1.0.0, available at 
+http://contributor-covenant.org/version/1/0/0/

DESCRIPTION

@@ -1,8 +1,8 @@
 Package: albersusa
 Type: Package
 Title: Tools, Shapefiles & Data to Work with an 'AlbersUSA' Composite Projection
-Version: 0.3.0
-Date: 2017-01-26
+Version: 0.3.1
+Date: 2018-05-09
 Author: Bob Rudis (bob@rud.is)
 Maintainer: Bob Rudis <bob@rud.is>
 Description: Creating a composite projection for states and counties of the United States
@@ -10,7 +10,7 @@ Description: Creating a composite projection for states and counties of the Unit
     and potentially error-prone. Functions and data sets are provided to make it easier to
     produce maps with a composite projection. Furthermore, named projections for common
     transormations are provided to further increase mapping productivity.
-URL: http://github.com/hrbrmstr/albersusa
+URL: https://github.com/hrbrmstr/albersusa
 BugReports: https://github.com/hrbrmstr/albersusa/issues
 License: AGPL
 Suggests:
@@ -25,4 +25,5 @@ Imports:
     rgeos,
     rgdal,
     maptools
-RoxygenNote: 5.0.1
+Encoding: UTF-8
+RoxygenNote: 6.0.1.9000

README.Rmd

@@ -1,9 +1,17 @@
 ---
 output: rmarkdown::github_document
+editor_options: 
+  chunk_output_type: console
 ---
 [![Build Status](https://travis-ci.org/hrbrmstr/albersusa.svg?branch=master)](https://travis-ci.org/hrbrmstr/albersusa)
 
-`albersusa` : Tools, Shapefiles & Data to Work with an 'AlbersUSA' Composite Projection
+# albersusa
+
+Tools, Shapefiles & Data to Work with an 'AlbersUSA' Composite Projection
+
+## Description
+
+## What's Inside The Tin
 
 The following functions are implemented:
 
@@ -34,7 +42,7 @@ The following data sets are included:
 
 Also, the simplefeatures coluns and `@data` slot of each `SpatialPolygonsDataFrame` has some handy data you can use (like FIPS codes and state/county population information).
 
-### Installation
+## Installation
 
 ```{r eval=FALSE}
 devtools::install_github("hrbrmstr/albersusa")
@@ -44,7 +52,7 @@ devtools::install_github("hrbrmstr/albersusa")
 options(width=120)
 ```
 
-### Usage
+## Usage
 
 ```{r message=FALSE, fig.retina=2}
 library(albersusa)
@@ -152,13 +160,12 @@ gg + coord_proj(us_eqdc_proj)
 gg + coord_proj(us_lcc_proj)
 ```
 
-### Test Results
+### Session Info
 
 ```{r}
-library(albersusa)
-library(testthat)
+devtools::session_info()
+```
 
-date()
+## Code of Conduct
 
-test_dir("tests/")
-```
+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.

README.md

@@ -1,21 +1,34 @@
 
-[![Build Status](https://travis-ci.org/hrbrmstr/albersusa.svg?branch=master)](https://travis-ci.org/hrbrmstr/albersusa)
+[![Build
+Status](https://travis-ci.org/hrbrmstr/albersusa.svg?branch=master)](https://travis-ci.org/hrbrmstr/albersusa)
 
-`albersusa` : Tools, Shapefiles & Data to Work with an 'AlbersUSA' Composite Projection
+# albersusa
+
+Tools, Shapefiles & Data to Work with an ‘AlbersUSA’ Composite
+Projection
+
+## Description
+
+## What’s Inside The Tin
 
 The following functions are implemented:
 
--   `counties_sf`: Retreive a U.S. county composite map, optionally with a projection, as a simplefeature
--   `usa_sf`: Retreive a U.S. state composite map, optionally with a projection, as a simplefeature
+  - `counties_sf`: Retreive a U.S. county composite map, optionally with
+    a projection, as a simplefeature
+  - `usa_sf`: Retreive a U.S. state composite map, optionally with a
+    projection, as a simplefeature
 
 New ones:
 
--   `points_elided`: Shift points around Alaska and Hawaii to the elided area (by @rdinter)
+  - `points_elided`: Shift points around Alaska and Hawaii to the elided
+    area (by @rdinter)
 
 Some legacy ones:
 
--   `usa_composite`: Retreive a U.S. composite map, optionally with a projection
--   `counties_composite`: Retreive a U.S. county composite map, optionally with a projection
+  - `usa_composite`: Retreive a U.S. composite map, optionally with a
+    projection
+  - `counties_composite`: Retreive a U.S. county composite map,
+    optionally with a projection
 
 Pre-canned projection strings:
 
@@ -27,18 +40,22 @@ Pre-canned projection strings:
 
 The following data sets are included:
 
--   `system.file("extdata/composite_us_states.geojson.gz", package="albersusa")`
--   `system.file("extdata/composite_us_counties.geojson.gz", package="albersusa")`
+  - `system.file("extdata/composite_us_states.geojson.gz",
+    package="albersusa")`
+  - `system.file("extdata/composite_us_counties.geojson.gz",
+    package="albersusa")`
 
-Also, the simplefeatures coluns and `@data` slot of each `SpatialPolygonsDataFrame` has some handy data you can use (like FIPS codes and state/county population information).
+Also, the simplefeatures coluns and `@data` slot of each
+`SpatialPolygonsDataFrame` has some handy data you can use (like FIPS
+codes and state/county population information).
 
-### Installation
+## Installation
 
 ``` r
 devtools::install_github("hrbrmstr/albersusa")
 ```
 
-### Usage
+## Usage
 
 ``` r
 library(albersusa)
@@ -67,14 +84,14 @@ us_sf <- usa_sf("laea")
 plot(us_sf["pop_2012"])
 ```
 
-<img src="README_files/figure-markdown_github/unnamed-chunk-4-1.png" width="672" />
+<img src="README_files/figure-gfm/unnamed-chunk-4-1.png" width="672" />
 
 ``` r
 cty_sf <- counties_sf("aeqd")
 plot(cty_sf["census_area"])
 ```
 
-<img src="README_files/figure-markdown_github/unnamed-chunk-4-2.png" width="672" />
+<img src="README_files/figure-gfm/unnamed-chunk-4-2.png" width="672" />
 
 ### Legacy
 
@@ -104,14 +121,14 @@ dplyr::glimpse(us@data)
 plot(us, lwd=0.25)
 ```
 
-<img src="README_files/figure-markdown_github/unnamed-chunk-5-1.png" width="672" />
+<img src="README_files/figure-gfm/unnamed-chunk-5-1.png" width="672" />
 
 ``` r
 us <- usa_composite("laea")
 plot(us, lwd=0.25)
 ```
 
-<img src="README_files/figure-markdown_github/unnamed-chunk-5-2.png" width="672" />
+<img src="README_files/figure-gfm/unnamed-chunk-5-2.png" width="672" />
 
 ``` r
 us <- usa_composite()
@@ -126,43 +143,43 @@ gg <- gg + theme_map()
 gg + coord_map()
 ```
 
-<img src="README_files/figure-markdown_github/unnamed-chunk-5-3.png" width="672" />
+<img src="README_files/figure-gfm/unnamed-chunk-5-3.png" width="672" />
 
 ``` r
 gg + coord_map("polyconic")
 ```
 
-<img src="README_files/figure-markdown_github/unnamed-chunk-5-4.png" width="672" />
+<img src="README_files/figure-gfm/unnamed-chunk-5-4.png" width="672" />
 
 ``` r
 gg + coord_proj()
 ```
 
-<img src="README_files/figure-markdown_github/unnamed-chunk-5-5.png" width="672" />
+<img src="README_files/figure-gfm/unnamed-chunk-5-5.png" width="672" />
 
 ``` r
 gg + coord_proj(us_laea_proj)
 ```
 
-<img src="README_files/figure-markdown_github/unnamed-chunk-5-6.png" width="672" />
+<img src="README_files/figure-gfm/unnamed-chunk-5-6.png" width="672" />
 
 ``` r
 gg + coord_proj(us_aeqd_proj)
 ```
 
-<img src="README_files/figure-markdown_github/unnamed-chunk-5-7.png" width="672" />
+<img src="README_files/figure-gfm/unnamed-chunk-5-7.png" width="672" />
 
 ``` r
 gg + coord_proj(us_eqdc_proj)
 ```
 
-<img src="README_files/figure-markdown_github/unnamed-chunk-5-8.png" width="672" />
+<img src="README_files/figure-gfm/unnamed-chunk-5-8.png" width="672" />
 
 ``` r
 gg + coord_proj(us_lcc_proj)
 ```
 
-<img src="README_files/figure-markdown_github/unnamed-chunk-5-9.png" width="672" />
+<img src="README_files/figure-gfm/unnamed-chunk-5-9.png" width="672" />
 
 ``` r
 gg + 
@@ -175,7 +192,7 @@ gg +
         legend.key.width=unit(3, "lines"))
 ```
 
-<img src="README_files/figure-markdown_github/unnamed-chunk-5-10.png" width="672" />
+<img src="README_files/figure-gfm/unnamed-chunk-5-10.png" width="672" />
 
 ``` r
 us <- counties_composite()
@@ -198,14 +215,14 @@ dplyr::glimpse(us@data)
 plot(us, lwd=0.25)
 ```
 
-<img src="README_files/figure-markdown_github/unnamed-chunk-5-11.png" width="672" />
+<img src="README_files/figure-gfm/unnamed-chunk-5-11.png" width="672" />
 
 ``` r
 us <- counties_composite("laea")
 plot(us, lwd=0.25)
 ```
 
-<img src="README_files/figure-markdown_github/unnamed-chunk-5-12.png" width="672" />
+<img src="README_files/figure-gfm/unnamed-chunk-5-12.png" width="672" />
 
 ``` r
 us <- counties_composite()
@@ -220,60 +237,141 @@ gg <- gg + theme_map()
 gg + coord_map()
 ```
 
-<img src="README_files/figure-markdown_github/unnamed-chunk-5-13.png" width="672" />
+<img src="README_files/figure-gfm/unnamed-chunk-5-13.png" width="672" />
 
 ``` r
 gg + coord_map("polyconic")
 ```
 
-<img src="README_files/figure-markdown_github/unnamed-chunk-5-14.png" width="672" />
+<img src="README_files/figure-gfm/unnamed-chunk-5-14.png" width="672" />
 
 ``` r
 gg + coord_proj()
 ```
 
-<img src="README_files/figure-markdown_github/unnamed-chunk-5-15.png" width="672" />
+<img src="README_files/figure-gfm/unnamed-chunk-5-15.png" width="672" />
 
 ``` r
 gg + coord_proj(us_laea_proj)
 ```
 
-<img src="README_files/figure-markdown_github/unnamed-chunk-5-16.png" width="672" />
+<img src="README_files/figure-gfm/unnamed-chunk-5-16.png" width="672" />
 
 ``` r
 gg + coord_proj(us_aeqd_proj)
 ```
 
-<img src="README_files/figure-markdown_github/unnamed-chunk-5-17.png" width="672" />
+<img src="README_files/figure-gfm/unnamed-chunk-5-17.png" width="672" />
 
 ``` r
 gg + coord_proj(us_eqdc_proj)
 ```
 
-<img src="README_files/figure-markdown_github/unnamed-chunk-5-18.png" width="672" />
+<img src="README_files/figure-gfm/unnamed-chunk-5-18.png" width="672" />
 
 ``` r
 gg + coord_proj(us_lcc_proj)
 ```
 
-<img src="README_files/figure-markdown_github/unnamed-chunk-5-19.png" width="672" />
-
-### Test Results
-
-``` r
-library(albersusa)
-library(testthat)
-
-date()
-```
+<img src="README_files/figure-gfm/unnamed-chunk-5-19.png" width="672" />
 
-    ## [1] "Thu Jan 26 23:57:29 2017"
+### Session Info
 
 ``` r
-test_dir("tests/")
+devtools::session_info()
 ```
 
-    ## testthat results ========================================================================================================
-    ## OK: 6 SKIPPED: 0 FAILED: 0
-    ## 
-    ## DONE ===================================================================================================================
+    ## Session info ----------------------------------------------------------------------------------------------------------
+
+    ##  setting  value                                 
+    ##  version  R version 3.5.0 RC (2018-04-15 r74605)
+    ##  system   x86_64, darwin15.6.0                  
+    ##  ui       X11                                   
+    ##  language (EN)                                  
+    ##  collate  en_US.UTF-8                           
+    ##  tz       America/New_York                      
+    ##  date     2018-05-09
+
+    ## Packages --------------------------------------------------------------------------------------------------------------
+
+    ##  package      * version    date       source                            
+    ##  albersusa    * 0.3.0      2018-05-09 local                             
+    ##  ash            1.0-15     2015-09-01 cran (@1.0-15)                    
+    ##  assertthat     0.2.0      2017-04-11 CRAN (R 3.5.0)                    
+    ##  backports      1.1.2      2017-12-13 CRAN (R 3.5.0)                    
+    ##  base         * 3.5.0      2018-04-16 local                             
+    ##  bindr          0.1.1      2018-03-13 CRAN (R 3.5.0)                    
+    ##  bindrcpp       0.2.2      2018-03-29 CRAN (R 3.5.0)                    
+    ##  class          7.3-14     2015-08-30 CRAN (R 3.5.0)                    
+    ##  classInt       0.2-3      2018-04-16 CRAN (R 3.5.0)                    
+    ##  colorspace     1.3-2      2016-12-14 CRAN (R 3.5.0)                    
+    ##  compiler       3.5.0      2018-04-16 local                             
+    ##  datasets     * 3.5.0      2018-04-16 local                             
+    ##  DBI            0.8        2018-03-02 CRAN (R 3.5.0)                    
+    ##  devtools       1.13.5     2018-02-18 CRAN (R 3.5.0)                    
+    ##  digest         0.6.15     2018-01-28 CRAN (R 3.5.0)                    
+    ##  dplyr          0.7.4      2017-09-28 CRAN (R 3.5.0)                    
+    ##  e1071          1.6-8      2017-02-02 cran (@1.6-8)                     
+    ##  evaluate       0.10.1     2017-06-24 CRAN (R 3.5.0)                    
+    ##  extrafont      0.17       2014-12-08 cran (@0.17)                      
+    ##  extrafontdb    1.0        2012-06-11 cran (@1.0)                       
+    ##  foreign        0.8-70     2017-11-28 CRAN (R 3.5.0)                    
+    ##  ggalt        * 0.6.0      2018-04-17 Github (hrbrmstr/ggalt@9ad95ba)   
+    ##  ggplot2      * 2.2.1.9000 2018-05-03 Github (tidyverse/ggplot2@6a261a2)
+    ##  ggthemes     * 3.4.2      2018-04-03 CRAN (R 3.5.0)                    
+    ##  glue           1.2.0      2017-10-29 CRAN (R 3.5.0)                    
+    ##  graphics     * 3.5.0      2018-04-16 local                             
+    ##  grDevices    * 3.5.0      2018-04-16 local                             
+    ##  grid           3.5.0      2018-04-16 local                             
+    ##  gridExtra      2.3        2017-09-09 CRAN (R 3.5.0)                    
+    ##  gtable         0.2.0      2016-02-26 CRAN (R 3.5.0)                    
+    ##  htmltools      0.3.6      2017-04-28 CRAN (R 3.5.0)                    
+    ##  KernSmooth     2.23-15    2015-06-29 CRAN (R 3.5.0)                    
+    ##  knitr          1.20       2018-02-20 CRAN (R 3.5.0)                    
+    ##  labeling       0.3        2014-08-23 CRAN (R 3.5.0)                    
+    ##  lattice        0.20-35    2017-03-25 CRAN (R 3.5.0)                    
+    ##  lazyeval       0.2.1      2017-10-29 CRAN (R 3.5.0)                    
+    ##  magrittr       1.5        2014-11-22 CRAN (R 3.5.0)                    
+    ##  mapproj        1.2.6      2018-03-29 CRAN (R 3.5.0)                    
+    ##  maps           3.3.0      2018-04-03 cran (@3.3.0)                     
+    ##  maptools     * 0.9-2      2017-03-25 CRAN (R 3.5.0)                    
+    ##  MASS           7.3-50     2018-04-30 CRAN (R 3.5.0)                    
+    ##  memoise        1.1.0      2017-04-21 CRAN (R 3.5.0)                    
+    ##  methods      * 3.5.0      2018-04-16 local                             
+    ##  munsell        0.4.3      2016-02-13 CRAN (R 3.5.0)                    
+    ##  pillar         1.2.2      2018-04-26 CRAN (R 3.5.0)                    
+    ##  pkgconfig      2.0.1      2017-03-21 CRAN (R 3.5.0)                    
+    ##  plyr           1.8.4      2016-06-08 CRAN (R 3.5.0)                    
+    ##  proj4          1.0-8      2012-08-05 cran (@1.0-8)                     
+    ##  R6             2.2.2      2017-06-17 CRAN (R 3.5.0)                    
+    ##  RColorBrewer   1.1-2      2014-12-07 CRAN (R 3.5.0)                    
+    ##  Rcpp           0.12.16    2018-03-13 CRAN (R 3.5.0)                    
+    ##  rgdal          1.2-18     2018-03-17 CRAN (R 3.5.0)                    
+    ##  rgeos        * 0.3-26     2017-10-31 CRAN (R 3.5.0)                    
+    ##  rlang          0.2.0.9001 2018-05-03 Github (r-lib/rlang@4803704)      
+    ##  rmarkdown      1.9        2018-03-01 CRAN (R 3.5.0)                    
+    ##  RPostgreSQL    0.6-2      2017-06-24 CRAN (R 3.5.0)                    
+    ##  rprojroot      1.3-2      2018-01-03 CRAN (R 3.5.0)                    
+    ##  Rttf2pt1       1.3.6      2018-02-22 cran (@1.3.6)                     
+    ##  scales       * 0.5.0.9000 2018-05-04 Github (hadley/scales@d767915)    
+    ##  sf           * 0.6-2      2018-04-25 CRAN (R 3.5.0)                    
+    ##  sp           * 1.2-7      2018-01-19 CRAN (R 3.5.0)                    
+    ##  spData         0.2.8.3    2018-03-25 CRAN (R 3.5.0)                    
+    ##  stats        * 3.5.0      2018-04-16 local                             
+    ##  stringi        1.2.2      2018-05-02 cran (@1.2.2)                     
+    ##  stringr        1.3.0      2018-02-19 CRAN (R 3.5.0)                    
+    ##  tibble         1.4.2      2018-01-22 CRAN (R 3.5.0)                    
+    ##  tools          3.5.0      2018-04-16 local                             
+    ##  udunits2       0.13       2016-11-17 cran (@0.13)                      
+    ##  units          0.5-1      2018-01-08 cran (@0.5-1)                     
+    ##  utils        * 3.5.0      2018-04-16 local                             
+    ##  viridis      * 0.5.1      2018-03-29 CRAN (R 3.5.0)                    
+    ##  viridisLite  * 0.3.0      2018-02-01 CRAN (R 3.5.0)                    
+    ##  withr          2.1.2      2018-05-03 Github (jimhester/withr@79d7b0d)  
+    ##  yaml           2.1.19     2018-05-01 CRAN (R 3.5.0)
+
+## Code of Conduct
+
+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.

man/albersusa.Rd

@@ -27,4 +27,3 @@ system.file("extdata/composite_us_counties.geojson.gz", package="albersusa")
 \author{
 Bob Rudis (bob@rud.is)
 }
-

man/counties_composite.Rd

@@ -45,4 +45,3 @@ library(sp)
 plot(counties_composite())
 plot(counties_composite("laea"))
 }
-

man/counties_sf.Rd

@@ -44,4 +44,3 @@ library(sf)
 plot(counties_sf()) # these take a while to render
 plot(counties_sf("laea"))
 }
-

man/points_elided.Rd

@@ -16,4 +16,3 @@ An elided version of the original SpatialPoints class
 This function will take a SpatialPoints object and shift the points around
  Alaska and Hawaii to the elided area from this package.
 }
-

man/us_aeqd_proj.Rd

@@ -24,8 +24,8 @@ us <- usa_composite(proj="aeqd")
 counties <- counties_composite("aeqd")
 }
 \seealso{
-Other convenience.projections: \code{\link{us_eqdc_proj}},
+Other convenience projections: \code{\link{us_eqdc_proj}},
   \code{\link{us_laea_proj}}, \code{\link{us_lcc_proj}}
 }
+\concept{convenience projections}
 \keyword{datasets}
-

man/us_eqdc_proj.Rd

@@ -25,8 +25,8 @@ counties <- counties_composite("eqdc")
 
 }
 \seealso{
-Other convenience.projections: \code{\link{us_aeqd_proj}},
+Other convenience projections: \code{\link{us_aeqd_proj}},
   \code{\link{us_laea_proj}}, \code{\link{us_lcc_proj}}
 }
+\concept{convenience projections}
 \keyword{datasets}
-

man/us_laea_proj.Rd

@@ -22,8 +22,8 @@ us <- usa_composite(proj="laea")
 counties <- counties_composite("laea")
 }
 \seealso{
-Other convenience.projections: \code{\link{us_aeqd_proj}},
+Other convenience projections: \code{\link{us_aeqd_proj}},
   \code{\link{us_eqdc_proj}}, \code{\link{us_lcc_proj}}
 }
+\concept{convenience projections}
 \keyword{datasets}
-

man/us_lcc_proj.Rd

@@ -22,8 +22,8 @@ us <- usa_composite(proj="lcc")
 counties <- counties_composite("lcc")
 }
 \seealso{
-Other convenience.projections: \code{\link{us_aeqd_proj}},
+Other convenience projections: \code{\link{us_aeqd_proj}},
   \code{\link{us_eqdc_proj}}, \code{\link{us_laea_proj}}
 }
+\concept{convenience projections}
 \keyword{datasets}
-

man/us_longlat_proj.Rd

@@ -21,4 +21,3 @@ us <- sp::spTransform(us, sp::CRS(us_longlat_proj))
 counties <- counties_composite()
 }
 \keyword{datasets}
-

man/usa_composite.Rd

@@ -1,5 +1,5 @@
 % Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/albersusa.R
+% Please edit documentation in R/albersusa.r
 \name{usa_composite}
 \alias{usa_composite}
 \title{Retreive a U.S. state composite map, optionally with a projection}
@@ -47,4 +47,3 @@ library(sp)
 plot(usa_composite())
 plot(usa_composite("laea"))
 }
-

man/usa_sf.Rd

@@ -49,4 +49,3 @@ library(sf)
 plot(usa_sf()) # these take a while to render
 plot(usa_sf("laea"))
 }
-