man-roxygen/class_crs_methods.R

In jeanmathieupotvin/cargo: Data containers, schemas and prototypes

# class_crs_methods.R


#' @name CRS-methods
#'
#' @title
#' CRS: various methods for objects of class CRS from package \pkg{sp}
#'
#' @description
#' Miscellaneous functions to manipulate objects of class [`CRS`][sp::CRS-class]
#' in a more user-friendly way.
#'
#' @param x depends of the function used.
#' * For the [format()] method, an object of class [`CRS`][sp::CRS-class].
#' * For function [identical_crs()], theoretically any \R object.
#' @param y theoretically any \R object.
#' @param object an object of class [`CRS`][sp::CRS-class].
#' @param ... additional arguments to be passed to or from methods. Unused.
#'
#' @return
#' The [format()] method returns a named list.
#'
#' The [show()] method returns a `NULL` invisibly.
#'
#' [identical_crs()] returns a logical.
#'
#' @details
#' [identical_crs()] is a generic function designed to compare CRS between
#' objects having a spatial component. This is a more flexible alternative to
#' function [`identicalCRS()`][sp::CRS-class].
#'
#' @family Spatial-tools