Load DataSet from OSP snapshot observed data — loadDataSetFromSnapshot • osp.snapshots

Creates a DataSet object (from ospsuite package) from observed data in an OSP snapshot. This function converts snapshot observed data format to the standardized DataSet format used throughout the OSP ecosystem.

Usage

loadDataSetFromSnapshot(observedDataStructure)

Arguments

observedDataStructure: Raw observed data structure from a snapshot JSON

Value

A DataSet object from the ospsuite package

Details

This function follows the same pattern as other DataSet loading functions in ospsuite:

ospsuite::loadDataSetFromPKML()
ospsuite::loadDataSetFromExcel()
osp.snapshots::loadDataSetFromSnapshot() (this function)

ObservedData is a backwards-compatible alias for loadDataSetFromSnapshot() and may be retired in a future release if this functionality migrates to the ospsuite package. Prefer the loadDataSetFromSnapshot() name in new code.

Migration Plan

This function is designed for eventual migration to the ospsuite package. When migrated, the usage pattern will be:

# Future usage (when moved to ospsuite):
dataset <- ospsuite::loadDataSetFromSnapshot(observedDataStructure)

# Current usage:
dataset <- osp.snapshots::loadDataSetFromSnapshot(observedDataStructure)

# Migration steps:
# 1. Copy this function to ospsuite package
# 2. Update osp.snapshots to import from ospsuite
# 3. Eventually remove from osp.snapshots