Skip to content

Commit

Permalink
clarify docs; #2299
Browse files Browse the repository at this point in the history
  • Loading branch information
edzer committed Dec 19, 2023
1 parent ec39ef4 commit db96e85
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 15 deletions.
17 changes: 9 additions & 8 deletions R/crs.R
Original file line number Diff line number Diff line change
Expand Up @@ -392,15 +392,16 @@ is.na.crs = function(x) {
#' @examples
#' st_crs("EPSG:3857")$input
#' st_crs(3857)$proj4string
#' st_crs(3857)$b # numeric
#' st_crs(3857)$units # character
#' @details the \code{$} method for \code{crs} objects retrieves named elements
#' @details the `$` method for `crs` objects retrieves named elements
#' using the GDAL interface; named elements include
#' \code{"SemiMajor"}, \code{"SemiMinor"}, \code{"InvFlattening"}, \code{"IsGeographic"},
#' \code{"units_gdal"}, \code{"IsVertical"}, \code{"WktPretty"}, \code{"Wkt"},
#' \code{"Name"}, \code{"proj4string"}, \code{"epsg"}, \code{"yx"},
#' \code{"ud_unit"}, and \code{axes} (this may be subject to changes in future GDAL versions).
#' \code{"ud_unit"} returns a valid \link[units]{units} object or \code{NULL} if units are missing.
#' `SemiMajor`, `SemiMinor`, `InvFlattening`, `IsGeographic`,
#' `units_gdal`, `IsVertical`, `WktPretty`, `Wkt`,
#' `Name`, `proj4string`, `epsg`, `yx`,
#' `ud_unit`, and `axes` (this may be subject to changes in future GDAL versions).
#'
#' Note that not all valid CRS have a corresponding `proj4string`.
#'
#' `ud_unit` returns a valid \link[units]{units} object or `NULL` if units are missing.
#' @export
`$.crs` = function(x, name) {

Expand Down
15 changes: 8 additions & 7 deletions man/st_crs.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit db96e85

Please sign in to comment.