init: A convenience function for initialising 'Piecemeal' objects.

View source: R/Piecemeal.R

initR Documentation

A convenience function for initialising Piecemeal objects.

Description

There is rarely a reason to attach piecemeal via library(), so piecemeal::init(outdir) is provided as shorthand for Piecemeal⁠$new(outdir)⁠.

Usage

init(outdir)

Arguments

outdir

the directory to hold the partial simulation results.

Value

A Piecemeal object.

See Also

Piecemeal

Examples

outdir <- file.path(tempdir(), "piecemeal_demo")
sim <- piecemeal::init(outdir)
# a.k.a. piecemeal::Piecemeal$new(outdir)
# a.k.a.
# library(piecemeal)
# Piecemeal$new(outdir)

piecemeal documentation built on March 11, 2026, 5:07 p.m.