Generate therapeutic candidates
The step currently supports ASO and gapmer designs. siRNA candidate generation is
not implemented; selecting sirna fails during parameter validation.
Select the modality with parameters.antisense.modality.type and place its
mechanism at parameters.antisense.modality.mechanism and its design settings
under parameters.antisense.modality.design. For example,
the CLI selects a gapmer with --param antisense.modality.type=aso and
--param antisense.modality.design.type=gapmer, followed by its segment
lengths. The gapmer design rules apply to the ASO modality.
Generates therapeutic candidates for target sites.
- Step type:
Core step
Run this step
ASOkai run --step generate-therapeutic-candidates --config-file ./config.yaml
Example configuration for this step and its dependencies:
datadir: ./data
parameters:
genome:
assembly: GRCh38
release: 114
source: ensembl
species: Homo_sapiens
target:
target_id: ENSG00000133703
k: 16
region: pre-mrna
antisense:
modality:
type: aso
design:
type: gapmer
left_wing_length: 3
gap_length: 10
right_wing_length: 3
mechanism: rnase-h1
Parameters
These scalar configuration values are passed to this step.
Common parameters
Configuration path |
Details |
|---|---|
|
Accepted value: integer; minimum: 1 Requirement: Required Description: Target-site length. |
|
Accepted value: string; minimum string length: 1 Requirement: Required Description: Antisense therapeutic modality. |
|
Accepted value: string; minimum string length: 1 Requirement: Required Description: Therapeutic mechanism of action for the selected modality. |
Designs
Gapmer design
Set parameters.antisense.modality.type to aso and parameters.antisense.modality.design.type to gapmer.
Example configuration:
parameters:
antisense:
modality:
type: aso
design:
type: gapmer
left_wing_length: 3
gap_length: 10
right_wing_length: 3
Configuration path |
Details |
|---|---|
|
Accepted value: integer; minimum: 1 Requirement: Required when parameters.antisense.modality.design.type is gapmer Description: Number of nucleotides in the left gapmer wing. Required for a gapmer design and not used by an unmodified design. |
|
Accepted value: integer; minimum: 1 Requirement: Required when parameters.antisense.modality.design.type is gapmer Description: Number of nucleotides in the central gapmer gap. Required for a gapmer design and not used by an unmodified design. |
|
Accepted value: integer; minimum: 1 Requirement: Required when parameters.antisense.modality.design.type is gapmer Description: Number of nucleotides in the right gapmer wing. Required for a gapmer design and not used by an unmodified design. |
Unmodified design
Set parameters.antisense.modality.type to aso and parameters.antisense.modality.design.type to unmodified.
Example configuration:
parameters:
antisense:
modality:
type: aso
design:
type: unmodified
This option has no additional parameters.
Parameter rules
exactly one of these config values is required: target_id, target_name
Inputs
An input with a fixed producer uses that output by default. A selected run can instead link a named output or supply an existing path. The input’s path override in config.yaml also selects an existing file. External paths are validated against the input’s file contract.
File input |
Details |
|---|---|
|
Producer output: create-target-gene. Shared config source: Format: JSON — Description: Serialized target gene object from create-target-gene. |
Example path-override configuration:
steps:
generate-therapeutic-candidates:
inputs:
target_gene:
path: /path/to/target_gene.json
Resources
Configurable resources use the first value in the resolution order shown below.
Resource setting |
Details |
|---|---|
|
Step override: Shared default: Built-in fallback: 4096 Accepted value: integer; minimum: 1 Description: Memory in mebibytes allocated to this step. |
Outputs
File output paths are relative to datadir. Braced names are replaced with the corresponding parameter values.
File outputs
File output |
Details |
|---|---|
|
Format: JSON — list[ Description: Serialized therapeutic candidates. Path template: Example path: |
|
Format: JSON — list[ Description: Serialized relationships between therapeutic IDs and input target-site IDs. Path template: Example path: |