Package index

Hub Connections

Functions for connecting to hubs and hub data

connect_hub() connect_model_output()

Connect to model output data.

connect_target_oracle_output() experimental

Open connection to oracle-output target data

connect_target_timeseries() experimental

Open connection to time-series target data

Data Collection

Functions for collecting data from hub connections

collect_hub()

Collect Hub model output data

collect_zoltar()

Load forecasts from zoltardata.com in hubverse format

Schema Creation and Management

Functions for creating and managing Arrow schemas

create_hub_schema()

Create a Hub arrow schema

create_oracle_output_schema()

Create oracle-output target data file schema

create_timeseries_schema()

Create time-series target data file schema

coerce_to_hub_schema() coerce_to_character()

Coerce data.frame/tibble column data types to hub schema data types or character.

as_r_schema() arrow_schema_to_string() is_supported_arrow_type() validate_arrow_schema()

Convert or validate an Arrow schema for compatibility with base R column types

Model Output Utilities

Functions for working with model outputs

expand_model_out_val_grid() defunct

Create expanded grid of valid task ID and output type value combinations

create_model_out_submit_tmpl() defunct

Create a model output submission file template

load_model_metadata()

Compile hub model metadata

Target Data Utilities

Helper functions for target data

get_target_data_colnames()

Get expected target data column names from config

get_target_file_ext()

Get target data file unique file extensions.

get_target_path()

Get the path(s) to the target data file(s) in the hub directory.

Cloud Storage

Functions for working with cloud storage

s3_bucket

Connect to an AWS S3 bucket

gs_bucket

Connect to a Google Cloud Storage (GCS) bucket

get_s3_bucket_name()

Get the bucket name for the cloud storage location.

Hive Partitioning

Functions for working with hive-partitioned data

extract_hive_partitions()

Extract Hive-style partition key-value pairs from a path

is_hive_partitioned_path()

Check whether a path contains Hive-style partitioning

Data Type Conversion

Utilities for converting between Arrow and R data types

arrow_to_r_datatypes

Mapping of Arrow types to base R types

r_to_arrow_datatypes()

Create R type to Arrow DataType mapping

Package Documentation and Utilities

Package-level documentation, print methods, and re-exports

print(<hub_connection>) print(<mod_out_connection>)

Print a <hub_connection> or <mod_out_connection> S3 class object

`%>%`

Pipe operator

reexports as_model_out_tbl validate_model_out_tbl model_id_merge model_id_split

Objects exported from other packages