| Title: | What the Package Does (One Line, Title Case) |
|---|---|
| Description: | What the package does (one paragraph). |
| Authors: | Josiah Parry [aut, cre]  |
| Maintainer: | Josiah Parry <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.0.0.9000 |
| Built: | 2024-09-02 02:53:33 UTC |
| Source: | https://github.com/josiahparry/sdf |
Required Generics
is_geometry(x) bounding_box(x) combine_geometry(x)is_geometry(x) bounding_box(x) combine_geometry(x)
sdf_join().Predicates should return a sparse matrix list representation. The elements the list
are an integer vector indicating the features where the predicate is TRUE.
The vector must be the row position.
sdf_intersects(x, y, ...) sdf_contains(x, y, ...) sdf_within(x, y, ...) sdf_crosses(x, y, ...) sdf_covers(x, y, ...) sdf_covered_by(x, y, ...) sdf_equals(x, y, ...) sdf_disjoint(x, y, ...) sdf_touches(x, y, ...) sdf_overlaps(x, y, ...)sdf_intersects(x, y, ...) sdf_contains(x, y, ...) sdf_within(x, y, ...) sdf_crosses(x, y, ...) sdf_covers(x, y, ...) sdf_covered_by(x, y, ...) sdf_equals(x, y, ...) sdf_disjoint(x, y, ...) sdf_touches(x, y, ...) sdf_overlaps(x, y, ...)
Left join only
sdf_join(x, y, predicate = sdf_intersects, ..., suffix = c("_x", "_y"))sdf_join(x, y, predicate = sdf_intersects, ..., suffix = c("_x", "_y"))
predicate |
a function that returns a sparse matrix list representation |
Optional Generics
sdf_length(x, ...) sdf_area(x, ...)sdf_length(x, ...) sdf_area(x, ...)
These functions are optional but strongly suggested.
union_geometry(x) simplify_geometry(x, ...) buffer_geometry(x, distance, ...) centroid(x) convex_hull(x) concave_hull(x, concavity, ...)union_geometry(x) simplify_geometry(x, ...) buffer_geometry(x, distance, ...) centroid(x) convex_hull(x) concave_hull(x, concavity, ...)
These templates can be used to extend sdf by implementing a new compatible geometry vector column.
use_sdf_template_class( class, save_as = paste0("R/sdf-compat-", class, ".R"), open = TRUE ) use_sdf_template_zzz(class, save_as = "R/zzz.R", open = TRUE)use_sdf_template_class( class, save_as = paste0("R/sdf-compat-", class, ".R"), open = TRUE ) use_sdf_template_zzz(class, save_as = "R/zzz.R", open = TRUE)
class |
a scalar character of the class name of your geometry class |
save_as |
Path of file to create, relative to root of active project.
Defaults to |
open |
Open the newly created file for editing? Happens in RStudio, if
applicable, or via |
use_sdf_template_class() will create an R script with the scaffolding
needed to implement your geometry class to be compatible with sdf.
use_sdf_template_zzz() will create a zzz.R file that will export your
methods to be available to sdf.