shapefile_list: A list of pre-made shapefiles for 'basemap'

View source: R/shapefile_list.R

shapefile_listR Documentation

A list of pre-made shapefiles for basemap

Description

Lists available pre-made shapefiles for plotting in the basemap function. Gives also instructions how to make custom ones.

Usage

shapefile_list(name, get.data = FALSE)

Arguments

name

A character argument giving the name of a pre-made shapefile. Will be partially matched. Use "all" to list all available ones.

get.data

Logical indicating whether spatial data should be returned instead of names of spatial data objects.

Details

Custom shapefiles for basemap should be defined as lists with (at least) following names (everything should be provided as characters):

  • land Name of the object containing land polygons. Required.

  • glacier Name of the object containing glacier polygons. Use NULL if glaciers are not needed.

  • bathy Name of the object containing land polygons. Use NULL if bathymetry is not needed.

All linked spatial data objects must be in same projection. High-resolution pre-made data are still under development and may not be available. Pre-made shapefiles contain additional elements that are used in the basemap function, but not required for custom shapefile datasets.

Value

Returns a data frame of provided pre-made shapefiles, if name = "all". Returns a shapefile list containing the information for a particular map otherwise.

Author(s)

Mikko Vihtakari

See Also

Other basemap functions: basemap(), qmap(), transform_coord()

Examples

shapefile_list("all")
shapefile_list("Arctic") # partial matching

ggOceanMaps documentation built on May 29, 2024, 5:36 a.m.