rename functions world_countries and world_states to ne_countries & n…

…e_states
ropensci · Nov 25, 2015 · 2a7c2a9 · 2a7c2a9
1 parent 8901053
commit 2a7c2a9
Show file tree

Hide file tree

Showing 13 changed files with 77 additions and 77 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -1,9 +1,9 @@
 # Generated by roxygen2: do not edit by hand
 
+export(ne_countries)
 export(ne_download)
 export(ne_file_name)
 export(ne_load)
-export(world_countries)
-export(world_states)
+export(ne_states)
 import(rgdal)
 import(sp)
diff --git a/R/get_data.r b/R/get_data.r
@@ -1,6 +1,6 @@
 #' Get data from within the package
 #'
-#' returns world country polygons at a specified scale, used by world_countries()
+#' returns world country polygons at a specified scale, used by ne_countries()
 #'
 #' @param scale scale of map to return, one of \code{110}, \code{50}, \code{'small'}, \code{'medium'}
 #' @param type country type, one of 'countries', 'map_units', 'sovereignty'

diff --git a/R/rnaturalearth-package.r b/R/rnaturalearth-package.r
@@ -4,7 +4,7 @@
 #'
 #' @name rnaturalearth
 #' @docType package
-#' @seealso world_countries
+#' @seealso ne_countries
 #' @import sp rgdal
 #rgdal is needed for ne_download but we may want to put that in a separate package ?
 NULL

diff --git a/R/world_countries.r b/R/world_countries.r
@@ -1,4 +1,4 @@
-#' Get world country polygons
+#' Get natural earth world country polygons
 #'
 #' returns world country polygons at a specified scale
 #'
@@ -9,9 +9,9 @@
 #' @param geounit a character vector of geounit names. 
 #' @param sovereignty a character vector of sovereignty names.  
 #' @examples
-#' spdf_world <- world_countries()
-#' spdf_africa <- world_countries(continent='africa')
-#' spdf_france <- world_countries(country='france')
+#' spdf_world <- ne_countries()
+#' spdf_africa <- ne_countries(continent='africa')
+#' spdf_france <- ne_countries(country='france')
 #' 
 #' if (require(sp)) {
 #'   plot(spdf_world)
@@ -21,7 +21,7 @@
 #' @return A \code{SpatialPolygonsDataFrame} object.
 #' @export
 #' 
-world_countries <- function(scale = 110,
+ne_countries <- function(scale = 110,
                             type = 'countries',
                             continent = NULL,
                             country = NULL,

diff --git a/R/world_states.r b/R/world_states.r
@@ -1,6 +1,6 @@
-#' Get world state (admin level 1) polygons
+#' Get natural earth world state (admin level 1) polygons
 #'
-#' returns world state polygons (administrative level 1) for specified countries
+#' returns state polygons (administrative level 1) for specified countries
 #'
 #' @param country a character vector of country names. 
 #' @param geounit a character vector of geounit names. 
@@ -9,20 +9,20 @@
 #' @examples
 #' 
 #' #comparing using country and geounit to filter
-#' spdf_france_country <- world_states(country='france')
-#' spdf_france_geounit <- world_states(geounit='france')
+#' spdf_france_country <- ne_states(country='france')
+#' spdf_france_geounit <- ne_states(geounit='france')
 #'  
 #' if (require(sp)) {
 #'   plot(spdf_france_country)
 #'   plot(spdf_france_geounit) 
 #'   
-#'   plot(world_states(country ='united kingdom'))  
-#'   plot(world_states(geounit='england'))     
+#'   plot(ne_states(country ='united kingdom'))  
+#'   plot(ne_states(geounit='england'))     
 #' }
 #' @return A \code{SpatialPolygonsDataFrame} object.
 #' @export
 #' 
-world_states <- function(   country = NULL,
+ne_states <- function(   country = NULL,
                             geounit = NULL,
                             iso_a2 = NULL,
                             spdf = NULL) {

diff --git a/README.md b/README.md
@@ -27,11 +27,11 @@ Here using `sp::plot` as a simple, quick way to plot maps. Maps could also be ma
 require(sp)
 
 #world countries
-plot(world_countries())
+plot(ne_countries())
 #uk
-plot(world_countries(country = 'united kingdom'))
+plot(ne_countries(country = 'united kingdom'))
 #states, admin level1 boundaries
-plot(world_states(country ='spain')) 
+plot(ne_states(country ='spain')) 
 
 ```
 

diff --git a/man/get_data.Rd b/man/get_data.Rd
diff --git a/man/world_countries.Rd → man/ne_countries.Rd b/man/world_countries.Rd → man/ne_countries.Rd
diff --git a/man/world_states.Rd → man/ne_states.Rd b/man/world_states.Rd → man/ne_states.Rd
diff --git a/man/rnaturalearth.Rd b/man/rnaturalearth.Rd
diff --git a/tests/testthat/test-world_countries.r b/tests/testthat/test-world_countries.r
@@ -1,8 +1,8 @@
-context("world countries : data saved in package")
+context("ne countries : data saved in package")
 
-spdf_world <- world_countries()
-spdf_africa <- world_countries(continent='africa')
-spdf_france <- world_countries(country='france')
+spdf_world <- ne_countries()
+spdf_africa <- ne_countries(continent='africa')
+spdf_france <- ne_countries(country='france')
 
 test_that("type of object returned is as expected", {
   expect_is(spdf_world, "SpatialPolygonsDataFrame")
@@ -21,33 +21,33 @@ test_that("number of rows/polygons in objects is as expected", {
 
 test_that("scale argument gives expected relative sizes of objects", {
 
-  expect_more_than( object.size(world_countries(scale='medium')),
-                    object.size(world_countries(scale='small')) )
+  expect_more_than( object.size(ne_countries(scale='medium')),
+                    object.size(ne_countries(scale='small')) )
 
-  expect_more_than( object.size(world_countries(scale=50)),
-                    object.size(world_countries(scale=110)) )
+  expect_more_than( object.size(ne_countries(scale=50)),
+                    object.size(ne_countries(scale=110)) )
 
 })
 
 test_that("equivalent scale arguments as numeric or text give identical results", {
 
-  expect_identical( world_countries(scale='medium'),
-                    world_countries(scale=50) )
+  expect_identical( ne_countries(scale='medium'),
+                    ne_countries(scale=50) )
 
-  expect_identical( world_countries(scale='small'),
-                    world_countries(scale=110) )
+  expect_identical( ne_countries(scale='small'),
+                    ne_countries(scale=110) )
 
 })
 
 test_that("Error message if incorrect filters are applied", {
-  expect_error(world_countries(continent='madeupname'))
-  expect_error(world_countries(country='madeupname'))
-  expect_error(world_countries(geounit='madeupname'))
-  expect_error(world_countries(sovereignty ='madeupname'))
+  expect_error(ne_countries(continent='madeupname'))
+  expect_error(ne_countries(country='madeupname'))
+  expect_error(ne_countries(geounit='madeupname'))
+  expect_error(ne_countries(sovereignty ='madeupname'))
 })
 
 test_that("Error message if incorrect type argument", {
-  expect_error(world_countries(type='madeupname'))
+  expect_error(ne_countries(type='madeupname'))
 })
 
 
diff --git a/vignettes/rnaturalearth.Rmd b/vignettes/rnaturalearth.Rmd
@@ -34,31 +34,31 @@ require(sp)
 ```{r, eval=TRUE, echo=TRUE, message=FALSE}
 
 #world at small scale (low resolution)
-sp::plot(world_countries(type='countries', scale='small'))
+sp::plot(ne_countries(type='countries', scale='small'))
 
 #countries, UK undivided
-sp::plot(world_countries(country = 'united kingdom', type='countries'))
+sp::plot(ne_countries(country = 'united kingdom', type='countries'))
 #map_units, UK divided into England, Scotland, Wales and Northern Ireland
-sp::plot(world_countries(country = 'united kingdom', type='map_units'))
+sp::plot(ne_countries(country = 'united kingdom', type='map_units'))
 
 
 #countries, large scale
-sp::plot(world_countries(country = 'united kingdom', scale='large'))
+sp::plot(ne_countries(country = 'united kingdom', scale='large'))
 
 #countries, medium scale
 #temporarily commented out to avoid utf conversion travis error with Curacao
-#sp::plot(world_countries(country = 'united kingdom', scale='medium'))
+#sp::plot(ne_countries(country = 'united kingdom', scale='medium'))
      
 #countries, small scale
-sp::plot(world_countries(country = 'united kingdom', scale='small'))   
+sp::plot(ne_countries(country = 'united kingdom', scale='small'))   
 
 #states country='united kingdom'
-sp::plot(world_states(country ='united kingdom'))  
+sp::plot(ne_states(country ='united kingdom'))  
 #states geounit='england'
-sp::plot(world_states(geounit='england')) 
+sp::plot(ne_states(geounit='england')) 
 
 #states country='france'
-sp::plot(world_states(country ='france'))  
+sp::plot(ne_states(country ='france'))  
 
 ```
 

diff --git a/vignettes/what-is-a-country.Rmd b/vignettes/what-is-a-country.Rmd
@@ -34,21 +34,21 @@ require(sp)
 ```{r, eval=TRUE, echo=TRUE, message=FALSE}
 
 #countries, UK undivided
-sp::plot(world_countries(country = 'united kingdom', type='countries'))
+sp::plot(ne_countries(country = 'united kingdom', type='countries'))
 #map_units, UK divided into England, Scotland, Wales and Northern Ireland
-sp::plot(world_countries(country = 'united kingdom', type='map_units'))
+sp::plot(ne_countries(country = 'united kingdom', type='map_units'))
 #sovereignty, Falkland Islands included in UK
-sp::plot(world_countries(country = 'united kingdom', type='sovereignty'), col='red')
+sp::plot(ne_countries(country = 'united kingdom', type='sovereignty'), col='red')
 sp::plot(coastline110, col='lightgrey', lty=3, add=TRUE)
 
 #France, country includes French Guiana
-sp::plot(world_countries(country = 'france'))
+sp::plot(ne_countries(country = 'france'))
 #France map_units includes French Guiana too
-sp::plot(world_countries(country = 'france', type='map_units'))
+sp::plot(ne_countries(country = 'france', type='map_units'))
 #France filter map_units by geounit to exclude French Guiana
-sp::plot(world_countries(geounit = 'france', type='map_units'))
+sp::plot(ne_countries(geounit = 'france', type='map_units'))
 #France sovereignty includes South Pacicic islands
-sp::plot(world_countries(country = 'france', type='sovereignty'), col='red')
+sp::plot(ne_countries(country = 'france', type='sovereignty'), col='red')
 sp::plot(coastline110, col='lightgrey', lty=3, add=TRUE)
 
 
@@ -59,14 +59,14 @@ sp::plot(coastline110, col='lightgrey', lty=3, add=TRUE)
 ```{r, eval=TRUE, echo=TRUE, message=FALSE}
 
 #countries, large scale
-sp::plot(world_countries(country = 'united kingdom', scale='large'))
+sp::plot(ne_countries(country = 'united kingdom', scale='large'))
 
 #countries, medium scale
 #temporarily commented out to avoid utf conversion travis error with Curacao
-#sp::plot(world_countries(country = 'united kingdom', scale='medium'))
+#sp::plot(ne_countries(country = 'united kingdom', scale='medium'))
      
 #countries, small scale
-sp::plot(world_countries(country = 'united kingdom', scale='small'))     
+sp::plot(ne_countries(country = 'united kingdom', scale='small'))     
      
      
 ```
@@ -76,14 +76,14 @@ sp::plot(world_countries(country = 'united kingdom', scale='small'))
 ```{r, eval=TRUE, echo=TRUE, message=FALSE}
 
 #states country='united kingdom'
-sp::plot(world_states(country ='united kingdom'))  
+sp::plot(ne_states(country ='united kingdom'))  
 #states geounit='england'
-sp::plot(world_states(geounit='england')) 
+sp::plot(ne_states(geounit='england')) 
 
 #states country='france'
-sp::plot(world_states(country ='france'))  
+sp::plot(ne_states(country ='france'))  
 #states geounit='france'
-sp::plot(world_states(geounit='france')) 
+sp::plot(ne_states(geounit='france')) 
 
 ```