Skip to contents

Core I/O

st_init()
Initialize stamp project structure
st_opts()
Get or set package options
st_opts_get()
Convenience getter (optional sugar)
st_opts_reset()
Reset all options to package defaults
st_path()
Declare a path (with optional format & partition hint)
st_part_path()
Build a concrete partition path under a base directory
st_list_parts()
List available partitions under a base directory
st_formats()
Inspect available formats
st_register_format()
Register or override a format handler
st_save()
Save an R object to disk with metadata & versioning (atomic move)
st_save_part()
Save a single partition (uses st_save under the hood)
st_write_parts()
Auto-partition and save a dataset (Hive-style)
st_load()
Load an object from disk (format auto-detected; optional integrity checks)
st_load_parts()
Load and row-bind partitioned data
st_load_version()
Load a specific version of an artifact

Versioning & Catalog

st_hash_obj()
Stable SipHash-1-3 of an R object
st_versions()
List versions for an artifact path
st_latest()
Get the latest version_id for an artifact path
st_prune_versions()
Prune stored versions according to a retention policy
st_rebuild()
Rebuild artifacts from a plan (level order)
st_plan_rebuild()
Plan a rebuild of descendants when parents changed

Lineage & Builders

st_children()
List children (reverse lineage) of an artifact
st_lineage()
Show immediate or recursive parents for an artifact
st_builders()
List registered builders
st_register_builder()
Register a builder for an artifact path
st_clear_builders()
Clear all builders (or only those for a given path)

Metadata & PKs

st_read_sidecar()
Read sidecar metadata (internal)
st_inspect_pk()
Inspect primary-key of an artifact from its sidecar
st_add_pk()
Add or repair primary-key metadata in an artifact sidecar
st_get_pk()
Read primary-key keys from a data.frame or sidecar/meta list
st_pk()
Normalize a primary-key specification
st_with_pk()
Attach primary-key metadata to a data.frame (in-memory)

Helpers

st_changed()
Check whether an artifact would change if saved now
st_changed_reason()
Explain why an artifact would change
st_should_save()
Decide if a save should proceed given current st_opts() Uses versioning policy and code-change rule.
st_is_stale()
Is a child artifact stale because its parents advanced?
st_info()
Inspect an artifact's current status (sidecar + catalog + snapshot location)
st_filter()
Filter a data.frame by primary-key values (or arbitrary columns)