Skip to content

crop.Rd: clarify 'snap' argument description #2183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rhijmans merged 2 commits into from
Sep 3, 2026
Merged

crop.Rd: clarify 'snap' argument description #2183

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4cd3da
crop.Rd: clarify 'snap' argument description
AMBarbosa Sep 2, 2026
a841f9d
some change
rhijmans Sep 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion man/crop.Rd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ You can crop a SpatVector with another SpatVector. If these are not polygons, th
\arguments{
\item{x}{SpatRaster or SpatVector}
\item{y}{SpatRaster, SpatVector, SpatExtent, or any other object that has a SpatExtent (\code{\link{ext}} returns a \code{SpatExtent})}
\item{snap}{character. One of "near", "in", or "out". Used to align \code{y} to the geometry of \code{x}}
\item{snap}{character. One of "near", "in", or "out". Used to align SpatExtent \code{y} to the geometry (cells) of \code{x}. You can snap the extent to the nearest cell boundaries; to the nearest cell boundaries that are inside the extent; or to the nearest cell boundaries that are outside the extent. This works independently of arguments \code{mask} and \code{touches})}
\item{mask}{logical. Should \code{y} be used to mask? Only used if \code{y} is a SpatVector, SpatRaster or sf}
\item{touches}{logical. If \code{TRUE} and \code{mask=TRUE}, all cells touched by lines or polygons will be masked, not just those on the line render path, or whose center point is within the polygon}
\item{extend}{logical. Should rows and/or columns be added if \code{y} is beyond the extent of \code{x}? Also see \code{\link{extend}}}
Expand Down
Loading