R/package.R

In Groupe-ElementR/SpatialPosition: Spatial Position Models

#' @title Spatial Position Package
#' @name SpatialPosition
#' @description Computes spatial position models: \itemize{
#' \item{Stewart potentials,}
#' \item{Reilly catchment areas,} 
#' \item{Huff catchment areas.}
#' }
#' An introduction to the package conceptual background and usage: \cr
#'  - \code{vignette(topic = "SpatialPosition")}\cr
#' A Stewart potentials use case:\cr
#'  - \code{vignette(topic = "StewartExample")}.
#' @references 
#' COMMENGES H., GIRAUD, T., LAMBERT, N. (2016) "ESPON FIT: Functional Indicators for Spatial-Aware Policy-Making", 
#' Cartographica: The International Journal for Geographic Information and Geovisualization, 51(3): 127-136.
#' @docType package
"_PACKAGE"

#' @title Public Hospitals
#' @description An sf POINT data frame of 18 public hospitals with their capacity 
#' ("capacity" = number of beds).
#' @name hospital
#' @docType data
NULL

#' @title Paris Polygon
#' @description An sf POLYGON data frame of the Paris perimeter. 
#' @name paris
#' @docType data
NULL