cfDatatype-class: The Clifro Datatype Object

In ropensci/clifro: Easily Download and Visualise Climate Data from CliFlo

The Clifro Datatype Object

Description

Create a cfDatatype object by selecting one or more CliFlo datatypes to build the clifro query.

Usage

cf_datatype(
  select_1 = NA,
  select_2 = NA,
  check_box = NA,
  combo_box = NA,
  graphics = FALSE
)

Arguments

select_1	a numeric vector of first node selections
select_2	a numeric vector of second node selections
check_box	a list containing the check box selections
combo_box	a numeric vector containing the combo box selection (if applicable)
graphics	a logical indicating whether a graphics menu should be used, if available

Details

An object inheriting from the cfDatatype class is created by the constructor function cf_datatype. The function allows the user to choose datatype(s) interactively (if no arguments are given), or to create datatypes programmatically if the tree menu nodes are known a priori (see examples). This function uses the same nodes, check box and combo box options as CliFlo and can be viewed at the datatype selection page.

Value

cfDatatype object

Note

For the 'public' user (see examples) only the Reefton Ews station data is available.

Currently clifro does not support datatypes from the special datasets (Ten minute, Tier2, Virtual Climate, Lysimeter) or upper air measurements from radiosondes and wind radar.

See Also

cf_user to create a clifro user, cf_station to choose the CliFlo stations and vignette("choose-datatype") for help choosing cfDatatypes.

Examples

## Not run: 
# Select the surface wind datatype manually (unknown tree nodes)
hourly.wind.dt = cf_datatype()
#  2  --> Datatype:        Wind
#  1  --> Datatype 2:      Surface Wind
#  2  --> Options:         Hourly Wind
# (2) --> Another option:  No
#  3  --> Units:           Knots
hourly.wind.dt

# Or select the datatype programatically (using the selections seen above)
hourly.wind.dt = cf_datatype(2, 1, 2, 3)
hourly.wind.dt

## End(Not run)

ropensci/clifro documentation built on March 17, 2023, 12:17 a.m.