circIndexShow: List all available circulation indices

View source: R/circIndexGrid.R

circIndexShowR Documentation

List all available circulation indices

Description

Print a table with a summary of the available circulation indices

Usage

circIndexShow()

Value

Print a table on the screen with the following columns:

  • code: Code of the index. This is the character string used as input value for the argument index.code in circIndexGrid

  • longname: Long description of the circulation index.

  • fun: The name of the function used to calculate it.

  • zg, hgt, sst, slp: A logical value (0/1) indicating the input variables required for index calculation

  • reference: Reference for the implemented calculation.

Author(s)

J. Bedia, M. Iturbide, A. Casanueva


SantanderMetGroup/climate4R.indices documentation built on July 3, 2023, 11:02 p.m.