Portability & Collaboration

Data bundles (share datasets/aliases)

Create, inspect, export, and import Specform data bundles.

Create a bundle plan

bundle = sf.data_bundle("paper_v1", sf.dataset("brca"))
bundle
bundle.datasets
bundle.aliases

Export bundle

path = bundle.export("paper_v1.sfds")
path

Inspect a bundle (before importing)

report = sf.inspect_data_bundle("paper_v1.sfds")
report
report.to_df()

Import a bundle

import_report = sf.import_data_bundle(
    "paper_v1.sfds",
    aliases="recreate",     # or "none"
    conflict="rename",      # or "skip"
)
import_report
import_report.to_df()