render_region_plot: Function to create a plot of a selected country.

View source: R/render_region_plot.R

render_region_plotR Documentation

Function to create a plot of a selected country.

Description

This function generates a plot of within a certain region (e.g. a country).

Usage

render_region_plot(
  infile,
  outfile = NULL,
  fileExtension = ".png",
  visualizeVariables,
  visualizeDataMax,
  lon_bounds,
  lat_bounds,
  lon_loc_vec,
  lat_loc_vec,
  name_loc_vec,
  division,
  selectedRegion,
  region_data,
  timestep,
  num_tick,
  num_rmin,
  num_rmax,
  location,
  text1,
  text2,
  text3,
  PAL,
  palettes,
  num_brk,
  reverse,
  textsize,
  bordercolor,
  plot_grid,
  grid_col,
  image_def,
  ihsf,
  nc = NULL
)

Arguments

infile

The nc file to be visualized.

outfile

Name of the outfile (NULL or character). Should match the fileExtension. If NULL is passed a file is created in the R session temporary directory.

fileExtension

The file extension of the image (character). Has to be one of the following: 'png', 'jpg', 'tif', 'kml', 'pdf'.

visualizeVariables

A data frame containing all meta data for the plotting process (data.frame).

visualizeDataMax

Maximal data for computing breaks.

lon_bounds

Array containing two values for longitude min and max (numeric).

lat_bounds

Array containing two values for latitude min and max (numeric).

lon_loc_vec

All longitude entries for points at (lat_loc_vec, lon_loc_vec) to be specified on the map (numeric).

lat_loc_vec

All latitude entries for points at (lat_loc_vec, lon_loc_vec) to be specified on the map (numeric).

name_loc_vec

Names for the points at (lat_loc_vec, lon_loc_vec) to be specified on the map (numeric).

division

Division to contain region (either 'COUNTRY' or something coherent to region_data).

selectedRegion

The region to be cropped according to division. If division == "COUNTRY", the country's 3-character ISO code should be used. Otherwise it has to fit to the passed region data.

region_data

If Division is not 'COUNTRY' then region_data has to contain spatial data of the given division.

timestep

Timestep to visualize at (character).

num_tick

Number of ticks (numeric).

num_rmin

Color scale range minimum (numeric).

num_rmax

Color scale range maximium (numeric).

location

Whether points specified by (lat_loc_vec, lon_loc_vec, name_loc_vec) should be added to the map (logical).

text1

Title text (character).

text2

Text to be passed to graphics::mtext (character).

text3

Text to be added to the legend (character).

PAL

Color palette.

palettes

Color palettes to be used.

num_brk

Number of breaks (numeric).

reverse

Whether to revert the color palette (logical).

textsize

Textsize to be used (cex).

bordercolor

Color used for borders.

plot_grid

Whether to plot a grid using color grid_col (logical).

grid_col

Color used for the grid.

image_def

Default size (positive numeric).

ihsf

Image height scaling factor (positive numeric).

nc

Alternatively to infile you can specify the input as an object of class ncdf4 (as returned from ncdf4::nc_open).


cmsafvis documentation built on March 18, 2022, 6:23 p.m.