add sf-package.Rd

closes #2197

R/defunct.R

@@ -14,7 +14,7 @@
 #' tables.
 #' @inheritParams st_read
 #' @export  st_read_db st_write_db
-#' @aliases sf-package st_read_db, st_write_db
+#' @aliases st_read_db, st_write_db
 #' @section Details:
 #' \tabular{rl}{
 #'   \code{st_read_db} \tab now a synonym for \code{\link{st_read}}\cr

R/sf.R

@@ -193,7 +193,7 @@ list_column_to_sfc = function(x) {
 #' Create sf object
 #'
 #' Create sf, which extends data.frame-like objects with a simple feature list column
-#' @name sf
+#' @name sf-object
 #' @param ... column elements to be binded into an \code{sf} object or a single \code{list} or \code{data.frame} with such columns; at least one of these columns shall be a geometry list-column of class \code{sfc} or be a list-column that can be converted into an \code{sfc} by \link{st_as_sfc}.
 #' @param crs coordinate reference system, something suitable as input to \link{st_crs}
 #' @param agr character vector; see details below.
@@ -301,7 +301,7 @@ st_sf = function(..., agr = NA_agr_, row.names,
 
 .sf_namespace <- function() NULL
 
-#' @name sf
+#' @name sf-object
 #' @param x object of class \code{sf}
 #' @param i record selection, see \link{[.data.frame}, or a \code{sf} object to work with the \code{op} argument
 #' @param j variable selection, see \link{[.data.frame}
@@ -402,7 +402,7 @@ st_sf = function(..., agr = NA_agr_, row.names,
 	x
 }
 
-#' @name sf
+#' @name sf-object
 #' @param n maximum number of features to print; can be set globally by \code{options(sf_max_print=...)}
 #' @export
 print.sf = function(x, ..., n = getOption("sf_max_print", default = 10)) {

man/sf-package.Rd

@@ -0,0 +1,30 @@
+\name{sf-package}
+\alias{sf-package}
+
+\alias{sf}
+
+\docType{package}
+
+\title{The \code{sf} package}
+
+\description{
+
+Package \code{sf} provides classes and methods to work with spatial
+vector data (points, lines, polygons).  The data structures and
+methods it implements follow the "Simple Feature Access" standard,
+which is also found in many other softwares like GDAL, GEOS, QGIS,
+PostGIS and other spatial databases. For introductions into the
+package please consult:
+
+Pebesma, E. and Bivand, R. (2023). Spatial Data
+Science: With Applications in R. Chapman and Hall/CRC.
+https://doi.org/10.1201/9780429459016 which is also found freely
+online at https://r-spatial.org/book/
+
+or
+
+Pebesma, E., 2018. Simple Features for R: Standardized Support
+for Spatial Vector Data. The R Journal 10 (1), 439-446,
+https://doi.org/10.32614/RJ-2018-009 (open access)
+
+}