Skip to content

API for Tables in GeoRegions.jl

GeoRegions.tableGeoRegions Method
julia
tableGeoRegions(;
    path :: AbstractString = homedir(),
    predefined :: Bool = true,
    giorgi     :: Bool = true,
    srex       :: Bool = true,
    ar6        :: Bool = true,
    custom     :: Bool = true,
    warn :: Bool = true,
    crop :: Bool = false,
    rows :: Int = 0
) -> nothing

Display all available GeoRegions in tabular format.

Keyword Arguments

  • path : The path where the list of custom GeoRegions will be retrieved from. Defaults to the user's home directory homedir().

  • predefined : If true, predefined Giorgi, SREX and IPPC AR6 list of GeoRegions will be displayed.

  • giorgi : If true AND predefined = true, display predefined GF GeoRegions. Default is true.

  • srex : If true AND predefined = true, display predefined SREX GeoRegions. Default is true.

  • ar6 : If true AND predefined = true, display predefined IPCC AR6 GeoRegions. Default is true.

  • custom : If true, custom, user-defined list of GeoRegions will be displayed.

  • warn : If true, display warnings if custom files do not exist.

  • crop : If true, will crop the vertical extent of the table, default is false.

source