GenerateModelsEngine

Internal engine that combines sources and algorithms into model specs.

Generate models engine

Public methods

• GenerateModelsEngine$new()
• GenerateModelsEngine$generate()
• GenerateModelsEngine$clone()

Method new()

Create a generate models engine

Usage

GenerateModelsEngine$new(workspace)

Arguments

workspace — PolyGenius workspace instance.

Method generate()

Build model resource specifications from sources and algorithms

Usage

GenerateModelsEngine$generate(
  sources,
  algorithms,
  target.build = NULL,
  naming = "auto",
  .execute = TRUE,
  .call = NULL
)

Arguments

sources — List of source specs

algorithms — List of algorithm specs

target.build — Optional target genome build for the returned model set. Model resources are generated and cached in their native build; when supplied, the resolved PGSLibrary is lifted after model generation.

naming — How to name models in the returned set: one of "auto" (set-aware minimal labels), "trait", "algorithm", "tuning", or "verbose". See generate$models().

.execute — Logical; when TRUE, trigger reactive execution to ensure model resources are materialized in cache.

.call — Optional captured call recorded verbatim in the returned set's .field provenance record. generate$models() passes its own match.call(); a direct engine caller may pass NULL.

Returns

When .execute = TRUE, a PGSLibrary containing all successfully generated models plus a set-level provenance record under .field provenance — the request (call, sources, algorithms, target.build, naming) and the run outcome (failure table, execution status/error, and the persisted stream and log paths). A model that failed is recorded in provenance(set)$misc$failed.models and warned about, not fatal to the rest; when no model at all resolved this aborts instead of returning an empty set. When .execute = FALSE, a ResourceSpecSet.

A set spanning several genome builds is returned without the multi-build advisory PGSLibrary() prints, because the batched collection path does not go through that constructor; pass target.build to converge the set instead.

Method clone()

The objects of this class are cloneable with this method.

Usage

GenerateModelsEngine$clone(deep = FALSE)

Arguments

deep — Whether to make a deep clone.

ExecutionEngine