region_definitions: region definitions dataframe

In oceanmap: A Plotting Toolbox for 2D Oceanographic Data

region definitions dataframe

Description

dataset providing spatial extent and color bar placement information by a region-keyword in later related function-calls (see: v, plotmap and regions). Information consists of a region-keyword, -longname, its spatial extent (longitudes and latitudes), grid resolution, as well as default colorbar position and figure size. 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

data(region_definitions)

Format

data.frame

Value

dataframe with the following header, containing the summary information of the region specified:

label name latn lats lonw lone ncol nrow px cbx1 cbx2 cby1 cby2 gradient oticks figxdim figydim grid.res

label	region-keywords
name	the long name of the region
latn & lats	northern and southern most latitude of the region
lonw & lone	western and eastern most longitude of the region
ncol, nrow & px	default matrix size per region described by the number of columns, rows and pixels. ATTENTION!! Regions of the same spatial extent but different default (matrix-) resolution may cause errors when reading or writing '.gz'-files and must therefore be distinguished by different keywords.
cbx1 & cbx2	x-coordinates for colorbar
cby1 & cby2	y-coordinates for colorbar
gradient	the color-gradient of the colorbar (x for horizontal, and y for vertical)
oticks	the margin where the colorbar ticks should be plotted, relative to the colorbar rectangle ('l' left, 'r' right and 'b' for bottom)
figxdim & figydim	the region-specific default plot device size (width and height in inches)
grid.res	the default grid resolution in degrees

Author(s)

Robert K. Bauer

See Also

See add.region to add new, backup or restore region definitions, and plotmap for basic landmask plots

Examples

data(region_definitions)
head(region_definitions)
region_definitions$label
# ?region_definitions

# figure(width=15,height=15)
# par(mfrow=c(5,6))
# for(n in region_definitions$label) plotmap(region = n,main=n)


# Mediterranean Sea with a spatial resolution of 4km (e.g. MODIS-Aqua)
region_definitions[region_definitions$label == 'med4',]

# Mediterranean Sea with a spatial resolution of 9km (e.g. dekkar)
region_definitions[region_definitions$label == 'med9',]

# plotting same landmasks by different region-keywords
plotmap('med4')
plotmap('med9')


## Example for selecting wrong area definition when saving files
path <- system.file("test_files", package="oceanmap")
gz.files <- Sys.glob(paste0(path,'/med4*.gz')) # load sample-med4'.gz'-files

fname <- name_split(gz.files[1])
param <- fname$parameter
gz <- readbin(gz.files[1])
dim(gz)
v(gz.files[1])

## reset region name
# fname$area <- 'med9'
# fname <- name_join(fname)
# writebin(gz,fname,param=param)
# v(fname,folder=".")
# system(paste('rm', fname))

oceanmap documentation built on Nov. 10, 2023, 5:08 p.m.