generate_synthetic_dataset: Generate a Synthetic Workbook Dataset

View source: R/synthetic.R

generate_synthetic_datasetR Documentation

Generate a Synthetic Workbook Dataset

Description

Generate a Synthetic Workbook Dataset

Usage

generate_synthetic_dataset(
  root,
  as_of = NULL,
  version = NULL,
  seed = NULL,
  bank_profile = "MID_SIZE_UNIVERSAL",
  config_root = NULL,
  overwrite = FALSE
)

Arguments

root

Parent directory for dated datasets.

as_of

Reporting date.

version

Dataset version.

seed

Integer lineage seed.

bank_profile

Profile identifier.

config_root

Optional profile configuration directory.

overwrite

Whether an existing dataset may be replaced.

Details

The function writes 16 canonical workbooks plus a dataset manifest. An existing non-empty target requires overwrite = TRUE.

Value

The generated dataset directory.

See Also

validate_dataset(), calculate_dataset()

Examples


generate_synthetic_dataset(file.path(tempdir(), "rwa-runs"),
                           bank_profile = "KSA_BANK")


riskweightedassets documentation built on Sept. 24, 2026, 5:12 p.m.