man-roxygen/class_geocontainer_methods.R

In jeanmathieupotvin/cargo: Data containers, schemas and prototypes

# class_geocontainer_methods.R


#' @name GeoContainer-methods
#'
#' @title
#' GeoContainer: various methods for objects of class GeoContainer
#'
#' @description
#' Some usual \R methods for objects of class
#' [`GeoContainer`][GeoContainer-class].
#'
#' @param x a [`GeoContainer`][GeoContainer-class] object.
#' @param ... further arguments passed to or from methods.
#'
#' @return
#' Return value depends on the function used.
#' * [as_spatial_points()] returns an object of class
#' [`sp::SpatialPoints`][sp::SpatialPoints()].
#' * [as_spatial_points_data_frame()] returns an object of class
#' [`sp::SpatialPointsDataFrame`][sp::SpatialPoints()]. The spatial
#' coordinates are kept in slot `data`.
#'
#' @details
#' Generic functions [as_spatial_points()] and
#' [as_spatial_points_data_frame()] do not exist in package
#' \pkg{sp}. They are defined here for convenience, with methods specific to
#' the [`GeoContainer`][GeoContainer-class] class.
#'
#' @family GeoContainer
#' @family Spatial-tools