PolyGenius
Contents

RestrictReferencePanelRule

Restrict reference panel rule

RestrictReferencePanelRule creates a reference-panel resource restricted to a named variant space. The source panel must be unrestricted.

Restriction is always the terminal step of a panel chain. The source is requested at the target build as a goal, so the download, convert and liftover rules materialize it as needed. See .claude/references/catalogs-map.md section 3 for the rationale.

Super class

PolyGenius::Rule -> RestrictReferencePanelRule

Methods

Public methods

  • RestrictReferencePanelRule$new()
  • RestrictReferencePanelRule$matches()
  • RestrictReferencePanelRule$inputs()
  • RestrictReferencePanelRule$requirements()
  • RestrictReferencePanelRule$run()
  • RestrictReferencePanelRule$clone()

Method new()

Create the restriction rule.

Usage

RestrictReferencePanelRule$new()

Method matches()

Check whether this rule applies to one output spec.

Usage

RestrictReferencePanelRule$matches(output.spec)

Arguments

output.spec — Output resource specification.

Returns

Logical.

Method inputs()

Build dependency inputs.

Usage

RestrictReferencePanelRule$inputs(output.spec)

Arguments

output.spec — Output resource specification.

Returns

Named list of dependency specs.

Method requirements()

Declare runtime requirements.

Usage

RestrictReferencePanelRule$requirements(output.spec, inputs)

Arguments

output.spec — Output resource specification.

inputs — Bound input values.

Returns

Named list with cores and memory.

Method run()

Execute panel restriction.

Usage

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

Arguments

output.spec — Output resource specification.

inputs — Bound input values.

logger — Rule logger.

Returns

Rule result list.

Method clone()

The objects of this class are cloneable with this method.

Usage

RestrictReferencePanelRule$clone(deep = FALSE)

Arguments

deep — Whether to make a deep clone.

See Also