man-roxygen/class_geocontainer.R

In jeanmathieupotvin/cargo: Data containers, schemas and prototypes

# class_geocontainer.R


#' @name GeoContainer-class
#'
#' @title
#' GeoContainer: a container for point spatial data
#'
#' @description
#' An extension of the [`Container`][Container-class] class holding metadata and
#' two-dimensional point spatial data.
#'
#' @section The GeoContainer class:
#' Class `GeoContainer` extends class [`Container`][Container-class] for point
#' data characterized by two-dimensional spatial coordinates. The added slots
#' hold relevent spatial metadata. The class leverage recognized \R packages
#' \pkg{sp} and \pkg{rgdal}. Package \pkg{cargo} also includes some tools to
#' work with spatial data.
#'
#' @section Using the class:
#' An object of class `GeoContainer` also *inherits* class [`Container`][Container-class].
#' This means that all features of the `Container` class can be used with objects
#' of class `GeoContainer`.
#'
#' * Create objects of class `GeoContainer` through the constructor function [GeoContainer()].
#' * Validate instances of the class by using [valid_geocontainer()].
#' * Test objects for class `GeoContainer` with introspector function [is_geocontainer()].
#' * Extract slots from instances of the class with functions [table()][table()],
#' [schema()], [xcol()], [ycol()] and [crs()].
#' * Extract spatial coordinates from instances of the class with function [xy()].
#' * Set new values to slots with functions [`table<-()`][table()],
#' [`schema<-()`][schema()], [`xcol<-()`][xcol()], [`ycol<-()`][ycol()] and
#' [`crs<-()`][crs()].
#' * Subset instances of the class by using the [`Container`][Container-class] methods
#' implemented for operators [`[`][Container-extractors], [`[[`][Container-extractors]
#' and [`$`][Container-extractors].
#'
#' @section Extending the GeoContainer class:
#' Users *should* extend this class to a super-class with additional slots by
#' using package \pkg{methods} only if their intent is to work with spatial
#' data. Else, the [`Container`][Container-class] class should be extended
#' instead.
#'
#' @family GeoContainer