clarifications

DESCRIPTION

@@ -12,9 +12,9 @@ Authors@R: c(
     person("EcoHealth Alliance", role="cph"),
     person("USAID PREDICT", role = "fnd"))
 Description: Provides a drop-in replacement for rasterize() from the 'raster'
-   package that takes 'sf'-type objects, and is much faster. There is support
-   for the main options provided by the rasterize() function, including
-   setting the field used and background value, and options for 
+   package that takes polygon vector or dataframe objects, and is much faster. 
+   There is support for the main options provided by the rasterize() function, 
+   including setting the field used and background value, and options for 
    aggregating multi-layer rasters. Uses the scan line algorithm attributed to
    Wylie et al. (1967) <doi:10.1145/1465611.1465619>.
 License: MIT + file LICENSE

R/fasterize.R

@@ -3,7 +3,7 @@ make_sf <- function(x, attr = NULL) {
 }
 
 
-#' Rasterize an sf object of polygons
+#' Rasterize a vector or dataframe object of polygons
 #'
 #' Rasterize set of polygons
 #'
@@ -14,12 +14,16 @@ make_sf <- function(x, attr = NULL) {
 #' is originally attributed to
 #' Wylie et al. (1967) \doi{10.1145/1465611.1465619}. 
 #'
-#' @param sf an [sf::sf()] object with a geometry column of POLYGON and/or
-#' MULTIPOLYGON objects.
+#' Note that original implementation worked only for sf dataframes of class "sf", but this 
+#' now works for any polygon vector (sfc, wkt, wkb, geos) or dataframe with a polygon vector
+#' supported by the wk package handlers. 
+#' 
+#' @param a polygon vector or data frame object with a geometry column of POLYGON and/or
+#' MULTIPOLYGON (equivalent) objects.
 #' @param raster A raster  object. Used as a template for the raster output.
 #' Can be created with [raster::raster()].
 #' The fasterize package provides a method to create a raster object from
-#' an sf object.
+#' an polygon dataset.
 #' @param field character. The name of a column in `sf`,
 #' providing a value for each of the polygons rasterized. If NULL (default),
 #' all polygons will be given a value of 1.

R/package.R

@@ -6,11 +6,10 @@
 ## usethis namespace: end
 NULL
 
-#' Fast sf-to-raster conversion
+#' Fast polygons-to-raster conversion
 #'
-#' Fast sf-to-raster conversion
+#' Fast polygons-to-raster conversion
 #'
-#' @docType package
 #' @name fasterize-package
 NULL