RestrictReferencePanelRule

Restrict reference panel rule

Description

Restrict reference panel rule

Restrict reference panel rule

Details

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

Super class

PolyGenius::Rule -> RestrictReferencePanelRule

Methods

Public methods

• RestrictReferencePanelRule$new()

• RestrictReferencePanelRule$matches()

• RestrictReferencePanelRule$inputs()

• RestrictReferencePanelRule$requirements()

• RestrictReferencePanelRule$run()

• RestrictReferencePanelRule$clone()

Inherited methods

• PolyGenius::Rule$bind()
• PolyGenius::Rule$print()

---

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)

Arguments

output.spec

Output resource specification.

inputs

Named list of 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.