# A Plotting Toolbox for 2D Oceanographic Data

## Documentation for package ‘oceanmap’ version 0.1.6

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

oceanmap-package | oceanmap - plot tools for 2D oceanographic data
.get.worldmap | World Map
add.region | adding a region to the region_definitions file
area_extrac | Extracts a pre-defined region from ".gz"-file and saves subset as a new ".gz"-file
bathy-class | v-classes
bindate2main | returns formatted date string for v-plot titles
bindate2Title | returns formatted date string for v-plot titles
bindate2ylab | returns formatted date string for v-plot titles
check_gzfiles | Returns summary on ".gz"-file types
check_ts | checks if daily ".gz"-file time series is complete
clim_plot | plots ".gz"-file climatologies
close_fig | function to close current graphic device
cmap | color maps
cmap_topo | color maps
delete.region | deletes a region from the region_definitions-definition file
empty.plot | Creates an empty scatter plot
figure | generate (and save) graphic devices with flexible fileformat selection
get.avg | returns the average value of circles with specified coordinates and a defined radius
get.avg.bathy | returns the average value of circles with specified coordinates and a defined radius
get.bathy | Returns bathymetric data from the NOAA ETOPO1 database as RasterLayer, given coordinate bounds and resolution.
get.gz.info | Returns a summary data frame of ".gz" encoded oceanography files by splitting their name
ggplotmap | plots landmask of a defined region
ggplotmaply | Converts a ggplot2 object from ggplotmap() to plotly
gz-class | v-classes
matrix2raster | Converts a matrix to a RasterLayer or arrays to a RasterStack-object
medm9_proj | internal datasets
name_join | create "'.gz"-filenames from a list or dataframe
name_split | Returns a summary data frame of ".gz" encoded oceanography files by splitting their name
nc-class | v-classes
nc2raster | Convert Raster layer to a matrix or array
nc2time | reads and converts the time variable of a netcdf-file ('.nc'-file) or 'ncdf4'-object as 'as.Date'-object
ncdf4-class | v-classes
oceanmap | oceanmap - plot tools for 2D oceanographic data
parameter_definitions | parameter definitions dataframe
param_convert | converts byte data to absolte values or vise versa ('param_unconvert')
param_unconvert | converts byte data to absolte values or vise versa ('param_unconvert')
plotmap | plots landmask of a defined region
raster2array | Convert Raster layer to a matrix or array
raster2matrix | Convert Raster layer to a matrix or array
readbin | Returns ".gz"-file as matrix or raster-object
regions | Returns two-row summary table of a specified region.
regions.dim.bathy | internal datasets
region_definitions | region definitions dataframe
region_definitions_bkp | region definitions dataframe
set.colorbar | Adds colorbar to an extisting plot device
set.colorbarp | Adds colorbar to an extisting plot device
SpatialCircle | Creates a circle of radius r around a specified point.
v | Plotting spatial data
v-method | Plotting spatial data
v.bathy | Plotting spatial data
v.gz | Plotting spatial data
v.plot | Plotting spatial data
v.raster | Plotting spatial data
writebin | Saves geographic data as byte file (".gz")