ropensci / rnaturalearth

An R package to hold and facilitate interaction with natural earth map data :earth_africa:
http://ropensci.github.io/rnaturalearth/
Other
216 stars 23 forks source link

Document related datasets in one file #4

Closed hadley closed 9 years ago

hadley commented 9 years ago

e.g.

#' World country polygons from Natural Earth.
#' 
#' @name countries
NULL

#' @format A \code{SpatialPolygonsDataFrame} with 177 elements
#' @source \url{http//www.naturalearthdata.com/download/}
#' @rdname coutries
"countries110"

Note that roxygen will automatically supply:

#' @docType data
#' @keywords dataset
#' @usage data(countries50)

so you can drop them

andysouth commented 9 years ago

Thanks, done, although is it possible to get e.g. ?countries110 to work ? I tried with @aliases but doesn't seem to

hadley commented 9 years ago

Yes. You shouldn't need to do anything extra (but you might need to build and reload the package)

andysouth commented 9 years ago

Thanks, that worked.