Skip to contents

Read a model output file

Source: R/read_model_out_file.R
read_model_out_file.Rd

Read a model output file

Usage

read_model_out_file(
  file_path,
  hub_path = ".",
  coerce_types = c("hub", "chr", "none")
)

Arguments

file_path

character string. Path to the file being validated relative to the hub's model-output directory.

hub_path

Either a character string path to a local Modeling Hub directory or an object of class <SubTreeFileSystem> created using functions s3_bucket() or gs_bucket() by providing a string S3 or GCS bucket name or path to a Modeling Hub directory stored in the cloud. For more details consult the Using cloud storage (S3, GCS) in the arrow package. The hub must be fully configured with valid admin.json and tasks.json files within the hub-config directory.

coerce_types

character. What to coerce column types to on read.

  • hub: read in (csv) or coerce (parquet, arrow) to hub schema.

  • chr: read in (csv) or coerce (parquet, arrow) all columns to character.

  • none: No coercion. Use arrow read_* function defaults.

Value

a tibble of contents of the model output file.