geo-registry

sf::st_join

How sf runs Spatial join: sf::st_join.

About this implementation
Engine sf
Tool name sf::st_join
Interface r
Implements Spatial join
Documentation Not stated
Effects modifies input: no, network: no
Notes Not stated
Status active

Parameters

Name Type Required Default Choices Note
x any yes Not stated Not stated Not stated
y any yes Not stated Not stated Not stated
join any yes Not stated Not stated Not stated
... dots no Not stated Not stated further arguments passed on

How it maps to the operation

Operation parameter Parameter here Note
left x Not stated
right y Not stated
predicate join intersects = st_intersects; within = st_within; contains = st_contains; touches = st_touches; crosses = st_crosses; overlaps = st_overlaps. join takes the predicate function itself (st_intersects), not its name as text.
how Not stated left = TRUE (the default) keeps unmatched rows; left = FALSE is an inner join. Passed through ...

Differences from the operation

None noted

Harvested by the r-packages harvester from engine version 1.1.3. Names can change when an engine is harvested again.