quicklook: Create a quicklook of NetCDF data

View source: R/quicklook.R

quicklookR Documentation

Create a quicklook of NetCDF data

Description

The function creates a plot of the variables in NetCDF file(s) specified in the config file. Only NetCDF files that conform to the CM SAF naming convention are supported.

Usage

quicklook(
  config,
  filelist,
  outpath = getwd(),
  jpeg_quality = 100,
  dpi = 150,
  iwidth = 1242,
  logo = TRUE,
  copyright = TRUE,
  bluemarble = FALSE,
  verbose = TRUE
)

Arguments

config

filename of configuration file. This may include the directory (character).

filelist

list of NetCDF file to create plots from (character).

outpath

directory in which to save the output files. (character).

jpeg_quality

jpeg quality for the image in percent, see grDevices::jpeg()

dpi

resolution of the image in dots per inch, see grDevices::jpeg()

iwidth

width of the resulting image in pixels, see grDevices::jpeg()

logo

logical; should the cmsaf logo be added to the plot?

copyright

logical; should the copyright text be added to the plot?

bluemarble

logical; should the data be plotted onto a NASA bluemarble (only available for MSG/Seviri based data)? Due to data size this option is not available for the cmsafvis package on CRAN. Please have a look at our website https://www.cmsaf.eu/R_toolbox

verbose

logical; if TRUE, progress messages are shown

Details

This operator can be applied using a configuration file (quicklook_config.yml). An example config file can be found in the extdata folder of this package. The following parameters can be defined:

  • logo: color / black

  • slot: numeric (e.g., 13)

  • invert_col: TRUE / FALSE

  • Dataset: character (e.g., ICDR Seviri Radiation)

  • limits: min: numeric; max: numeric

  • legend: TRUE / FALSE

  • colorscale: character (e.g., Viridis)

  • unit: character (e.g., Percent / '%')

Value

A jpeg file with the same name as the original NetCDF file.


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

Related to quicklook in cmsafvis...