diff --git a/README.md b/README.md index 84b6fd0..efc1b1f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ + [![Codecov test @@ -81,16 +82,11 @@ the `sf` package and read it in as an `sf` object: ``` r library(rmapshaper) -#> The legacy packages maptools, rgdal, and rgeos, underpinning the sp package, -#> which was just loaded, will retire in October 2023. -#> Please refer to R-spatial evolution reports for details, especially -#> https://r-spatial.org/r/2023/05/15/evolution4.html. -#> It may be desirable to make the sf package available; -#> package maintainers should consider adding sf to Suggests:. -#> The sp package is now running under evolution status 2 -#> (status 2 uses the sf package in place of rgdal) library(sf) #> Linking to GEOS 3.11.0, GDAL 3.5.3, PROJ 9.1.0; sf_use_s2() is TRUE +``` + +``` r file <- system.file("gpkg/nc.gpkg", package = "sf") nc_sf <- read_sf(file) diff --git a/man/apply_mapshaper_commands.Rd b/man/apply_mapshaper_commands.Rd index 7645475..cb9f6ca 100644 --- a/man/apply_mapshaper_commands.Rd +++ b/man/apply_mapshaper_commands.Rd @@ -40,7 +40,9 @@ Default \code{FALSE}. This can also be set globally with the option \item{gj2008}{Generate output that is consistent with the pre-RFC 7946 GeoJSON spec (dating to 2008). Polygon rings are CW and holes are CCW, -which is the opposite of the default RFC 7946-compatible output.} +which is the opposite of the default RFC 7946-compatible output. This should +be rarely needed, though may be useful when preparing data for D3-based +data visualizations (such as \code{plotly::plot_ly()}). Default \code{FALSE}} } \value{ geojson diff --git a/man/ms_clip.Rd b/man/ms_clip.Rd index e1cc788..d20626d 100644 --- a/man/ms_clip.Rd +++ b/man/ms_clip.Rd @@ -45,7 +45,9 @@ Default \code{FALSE}. This can also be set globally with the option \code{"mapshaper.sys_quiet"}} \item{\code{gj2008}}{Generate output that is consistent with the pre-RFC 7946 GeoJSON spec (dating to 2008). Polygon rings are CW and holes are CCW, -which is the opposite of the default RFC 7946-compatible output.} +which is the opposite of the default RFC 7946-compatible output. This should +be rarely needed, though may be useful when preparing data for D3-based +data visualizations (such as \code{plotly::plot_ly()}). Default \code{FALSE}} }} } \value{ @@ -56,7 +58,7 @@ Removes portions of the target layer that fall outside the clipping layer or bou } \examples{ -if (rmapshaper:::v8_version() >= 6) { +if (rmapshaper:::v8_version() >= "6") { library(geojsonsf, quietly = TRUE) library(sf) diff --git a/man/ms_dissolve.Rd b/man/ms_dissolve.Rd index 35451df..31a9dbd 100644 --- a/man/ms_dissolve.Rd +++ b/man/ms_dissolve.Rd @@ -52,7 +52,9 @@ Default \code{FALSE}. This can also be set globally with the option \code{"mapshaper.sys_quiet"}} \item{\code{gj2008}}{Generate output that is consistent with the pre-RFC 7946 GeoJSON spec (dating to 2008). Polygon rings are CW and holes are CCW, -which is the opposite of the default RFC 7946-compatible output.} +which is the opposite of the default RFC 7946-compatible output. This should +be rarely needed, though may be useful when preparing data for D3-based +data visualizations (such as \code{plotly::plot_ly()}). Default \code{FALSE}} }} } \value{ diff --git a/man/ms_erase.Rd b/man/ms_erase.Rd index 07b5b77..b724c5f 100644 --- a/man/ms_erase.Rd +++ b/man/ms_erase.Rd @@ -43,7 +43,9 @@ Default \code{FALSE}. This can also be set globally with the option \code{"mapshaper.sys_quiet"}} \item{\code{gj2008}}{Generate output that is consistent with the pre-RFC 7946 GeoJSON spec (dating to 2008). Polygon rings are CW and holes are CCW, -which is the opposite of the default RFC 7946-compatible output.} +which is the opposite of the default RFC 7946-compatible output. This should +be rarely needed, though may be useful when preparing data for D3-based +data visualizations (such as \code{plotly::plot_ly()}). Default \code{FALSE}} }} } \value{ @@ -53,7 +55,7 @@ erased target in the same format as the input target Removes portions of the target layer that fall inside the erasing layer or bounding box. } \examples{ -if (rmapshaper:::v8_version() >= 6) { +if (rmapshaper:::v8_version() >= "6") { library(geojsonsf, quietly = TRUE) library(sf) diff --git a/man/ms_explode.Rd b/man/ms_explode.Rd index 59b67c6..2ed2524 100644 --- a/man/ms_explode.Rd +++ b/man/ms_explode.Rd @@ -33,7 +33,9 @@ Default \code{FALSE}. This can also be set globally with the option \code{"mapshaper.sys_quiet"}} \item{\code{gj2008}}{Generate output that is consistent with the pre-RFC 7946 GeoJSON spec (dating to 2008). Polygon rings are CW and holes are CCW, -which is the opposite of the default RFC 7946-compatible output.} +which is the opposite of the default RFC 7946-compatible output. This should +be rarely needed, though may be useful when preparing data for D3-based +data visualizations (such as \code{plotly::plot_ly()}). Default \code{FALSE}} }} } \value{ diff --git a/man/ms_filter_islands.Rd b/man/ms_filter_islands.Rd index fc9bc29..80dab54 100644 --- a/man/ms_filter_islands.Rd +++ b/man/ms_filter_islands.Rd @@ -49,7 +49,9 @@ Default \code{FALSE}. This can also be set globally with the option \code{"mapshaper.sys_quiet"}} \item{\code{gj2008}}{Generate output that is consistent with the pre-RFC 7946 GeoJSON spec (dating to 2008). Polygon rings are CW and holes are CCW, -which is the opposite of the default RFC 7946-compatible output.} +which is the opposite of the default RFC 7946-compatible output. This should +be rarely needed, though may be useful when preparing data for D3-based +data visualizations (such as \code{plotly::plot_ly()}). Default \code{FALSE}} }} } \value{ diff --git a/man/ms_innerlines.Rd b/man/ms_innerlines.Rd index b078efc..8c5fc4e 100644 --- a/man/ms_innerlines.Rd +++ b/man/ms_innerlines.Rd @@ -33,7 +33,9 @@ Default \code{FALSE}. This can also be set globally with the option \code{"mapshaper.sys_quiet"}} \item{\code{gj2008}}{Generate output that is consistent with the pre-RFC 7946 GeoJSON spec (dating to 2008). Polygon rings are CW and holes are CCW, -which is the opposite of the default RFC 7946-compatible output.} +which is the opposite of the default RFC 7946-compatible output. This should +be rarely needed, though may be useful when preparing data for D3-based +data visualizations (such as \code{plotly::plot_ly()}). Default \code{FALSE}} }} } \value{ diff --git a/man/ms_lines.Rd b/man/ms_lines.Rd index 2b5ab3c..fd07234 100644 --- a/man/ms_lines.Rd +++ b/man/ms_lines.Rd @@ -40,7 +40,9 @@ Default \code{FALSE}. This can also be set globally with the option \code{"mapshaper.sys_quiet"}} \item{\code{gj2008}}{Generate output that is consistent with the pre-RFC 7946 GeoJSON spec (dating to 2008). Polygon rings are CW and holes are CCW, -which is the opposite of the default RFC 7946-compatible output.} +which is the opposite of the default RFC 7946-compatible output. This should +be rarely needed, though may be useful when preparing data for D3-based +data visualizations (such as \code{plotly::plot_ly()}). Default \code{FALSE}} }} } \value{ diff --git a/man/ms_points.Rd b/man/ms_points.Rd index bfa69f5..e14cf38 100644 --- a/man/ms_points.Rd +++ b/man/ms_points.Rd @@ -46,7 +46,9 @@ Default \code{FALSE}. This can also be set globally with the option \code{"mapshaper.sys_quiet"}} \item{\code{gj2008}}{Generate output that is consistent with the pre-RFC 7946 GeoJSON spec (dating to 2008). Polygon rings are CW and holes are CCW, -which is the opposite of the default RFC 7946-compatible output.} +which is the opposite of the default RFC 7946-compatible output. This should +be rarely needed, though may be useful when preparing data for D3-based +data visualizations (such as \code{plotly::plot_ly()}). Default \code{FALSE}} }} } \value{ diff --git a/man/ms_simplify.Rd b/man/ms_simplify.Rd index 83766d7..bda2a76 100644 --- a/man/ms_simplify.Rd +++ b/man/ms_simplify.Rd @@ -78,7 +78,9 @@ Default \code{FALSE}. This can also be set globally with the option \code{"mapshaper.sys_quiet"}} \item{\code{gj2008}}{Generate output that is consistent with the pre-RFC 7946 GeoJSON spec (dating to 2008). Polygon rings are CW and holes are CCW, -which is the opposite of the default RFC 7946-compatible output.} +which is the opposite of the default RFC 7946-compatible output. This should +be rarely needed, though may be useful when preparing data for D3-based +data visualizations (such as \code{plotly::plot_ly()}). Default \code{FALSE}} }} } \value{