Skip to contents

Build (or rebuild) the spine template for a given seed

Source: R/spine_template.R
build_spine_template.Rd

Generates n_template persons in Rust and writes them as a single parquet file at the cache path. Called automatically by generate_spine() when the template for the requested seed does not exist. Safe to call explicitly to pre-populate a cache.

Usage

build_spine_template(
  seed = 42L,
  n_template = .SPINE_TEMPLATE_DEFAULT_N,
  cache_dir = NULL,
  force = FALSE
)

Arguments

seed

Integer. Must match the seed passed to generate_spine().

n_template

Integer. Template size. Default 100000.

cache_dir

Character or NULL.

force

Logical. If TRUE, rebuild even if a template exists.

Value

Invisibly, the template path.