Skip to content

Gene index

Bases: GeneIndexStepConfig

Gene index step.

This step generates a gene index dataset from an Open Targets Platform target dataset.

Source code in src/otg/gene_index.py
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
@dataclass
class GeneIndexStep(GeneIndexStepConfig):
    """Gene index step.

    This step generates a gene index dataset from an Open Targets Platform target dataset.
    """

    session: Session = Session()

    def run(self: GeneIndexStep) -> None:
        """Run Target index step."""
        # Extract
        platform_target = self.session.spark.read.parquet(self.target_path)
        # Transform
        gene_index = GeneIndex.from_source(platform_target)
        # Load
        gene_index.df.write.mode(self.session.write_mode).parquet(self.gene_index_path)

run()

Run Target index step.

Source code in src/otg/gene_index.py
20
21
22
23
24
25
26
27
def run(self: GeneIndexStep) -> None:
    """Run Target index step."""
    # Extract
    platform_target = self.session.spark.read.parquet(self.target_path)
    # Transform
    gene_index = GeneIndex.from_source(platform_target)
    # Load
    gene_index.df.write.mode(self.session.write_mode).parquet(self.gene_index_path)

Gene index step requirements.

Attributes:

Name Type Description
target_path str

Open targets Platform target dataset path.

gene_index_path str

Output gene index path.

Source code in src/otg/config.py
234
235
236
237
238
239
240
241
242
243
244
245
@dataclass
class GeneIndexStepConfig:
    """Gene index step requirements.

    Attributes:
        target_path (str): Open targets Platform target dataset path.
        gene_index_path (str): Output gene index path.
    """

    _target_: str = "otg.gene_index.GeneIndexStep"
    target_path: str = MISSING
    gene_index_path: str = MISSING