regions: Returns two-row summary table of a specified region.

Description

Reorganizes summary information of a specified region from the region_definitionsset into a two-row dataframe. Region definitions can be added, backed up or restored by add.region or deleted by calling delete.region.

ATTENTION! When reinstalling or updating the oceanmap package, previous region definitions are getting lost! It is therefore highly recommanded to take and restore own backups (see: backup and restore).

Usage

regions(label)

Value

a two-row dataframe with the following header, containing the summary information of the region specified:

xlim

ylim

dim

name

cbx

cby

align

gradient

figdim

grid.res

xlim & ylim: the spatial extent of the region
dim: the number of grid points for both x & y-dimension
name: the long name of the region
cbx & cby: x & y-coordinates for colorbar
align: a vector defining the color-gradient of the colorbar (x for horizontal, and y for vertical), as well as the margin where the colorbar ticks should be plotted, relative to the colorbar rectangle ('l' left, 'r' right and 'b' for bottom)
figdim: the region-specific default plot device size
grid.res: the default grid resolution in degrees

Arguments

label: Character string indicating the name of the region of interest. If missing, list of available regions in the region_definitions-dataset will be returned by a error message.

Author

Robert K. Bauer

Examples

Run this code

## Example: return summary table for the Gulf of Lions
data('region_definitions')
region_definitions[region_definitions$label=='lion',] # select raw region data summary 
regions('lion') # return formatted summary table