PolyGenius
Contents

ResolveGctbRule

GCTB setup rule

Reactive rule that resolves the GCTB binary (used by SBayesR) into the workspace store. Used by the execution engine when any rule declares a gctb input and when workspace$setup$get("gctb") is called without a cached result.

GCTB is only available as a Linux x86_64 prebuilt binary. macOS and ARM users must compile from source and use workspace$setup$install(gctb = "/path").

Details

GCTB setup rule

Super class

PolyGenius::Rule -> ResolveGctbRule

Methods

Public methods

  • ResolveGctbRule$new()
  • ResolveGctbRule$matches()
  • ResolveGctbRule$inputs()
  • ResolveGctbRule$requirements()
  • ResolveGctbRule$run()

Method new()

Create the rule.

Usage

ResolveGctbRule$new()

Method matches()

Check whether this rule produces the requested output.

Usage

ResolveGctbRule$matches(output.spec)

Arguments

output.spec — Output resource specification.

Returns

TRUE for a gctb output.

Method inputs()

Declare upstream inputs.

Usage

ResolveGctbRule$inputs(output.spec)

Arguments

output.spec — Output resource specification.

Returns

An empty list; the rule has no inputs.

Method requirements()

Declare resource requirements.

Usage

ResolveGctbRule$requirements(output.spec, inputs)

Arguments

output.spec — Output resource specification.

inputs — Bound input values.

Returns

Named list with cores and memory.

Method run()

Resolve the resource.

Usage

ResolveGctbRule$run(output.spec, inputs, logger = pg.logger())

Arguments

output.spec — Output resource specification.

inputs — Named list of bound input values.

logger — Rule logger.

Returns

Rule result list with data, meta and logs.

See Also