Skip to content

Commit

Permalink
Fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ateucher committed Jan 11, 2017
1 parent 4f9bb58 commit 6de09b7
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 14 deletions.
12 changes: 7 additions & 5 deletions R/utils.R
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
#'
#' These functions are gone, no longer available.
#'
#' @param ... old defunct arguments
#'
#' \itemize{
#' \item \code{\link{fix_self_intersect}}: This function is defunct. Use \code{\link{fix_geo_problems}} instead.
#' }
Expand Down Expand Up @@ -70,9 +72,9 @@ km2_sq_mi <- function(x) {

#' Transform a Spatial* object to BC Albers projection
#'
#' @param sp_obj The Spatial* object to transform
#' @param obj The Spatial* or sf object to transform
#'
#' @return the Spatial* object in BC Albers projection
#' @return the Spatial* or sf object in BC Albers projection
#' @export
#'
transform_bc_albers <- function(obj) {
Expand Down Expand Up @@ -103,14 +105,14 @@ transform_bc_albers.sf <- function(obj) {

#' Check and fix polygons that self-intersect, and sometimes can fix orphan holes
#'
#' This uses the common method of buffering by zero, using gBuffer in the rgeos package.
#' This uses the common method of buffering by zero.
#'
#' \code{fix_self_intersect} has been removed and will no longer work. Use
#' \code{fix_geo_problems} instead
#'
#' @param sp_obj The SpatialPolygons* object to check/fix
#' @param obj The SpatialPolygons* or sf object to check/fix
#'
#' @return The SpatialPolygons* object, repaired if necessary
#' @return The SpatialPolygons* or sf object, repaired if necessary
#' @export
fix_geo_problems <- function(obj) {
UseMethod("fix_geo_problems")
Expand Down
10 changes: 6 additions & 4 deletions man/bcmaps-defunct.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions man/fix_geo_problems.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/transform_bc_albers.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 6de09b7

Please sign in to comment.