man-roxygen/class_geocontainer_slots.R

In jeanmathieupotvin/cargo: Data containers, schemas and prototypes

# class_geocontainer_slots.R


# Always merged with class_geocontainer.R.


#' @slot xcol a character. The name of the field in `table` that holds `x`
#' (east-west) spatial coordinates.
#'
#' @slot ycol a character. The name of the field in `table` that holds `y`
#' (north-south) spatial coordinates.
#'
#' @slot crs an object of class [`sp::CRS`][sp::CRS-class] holding spatial
#' coordinates' metadata. It *must* describe a valid Coordinates Reference
#' System (CRS).