# alexga/probeshiftr architecture

> Architecture diagram of the GitHub repository alexga/probeshiftr, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-31). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/alexga/probeshiftr
- Repository: https://github.com/alexga/probeshiftr

## Overview

##### Main Components Identification

The system should be represented with these key components:

a) Input Processing Layer:
- Target FASTA files
- Database FASTA files
- GTF/GFF annotation files
- Configuration parameters

b) Core Processing Components:
- Sequence Processing Engine
- Filtering System
- BLAT Integration
- R Script Integration

c) Output Generation Layer:
- Oligo designs
- Temporary files
- Log files (optional)

##### Component Relationships

a) Input Layer (Top):
- Use rounded rectangles for configuration parameters

b) Core Processing (Middle):
- Sub-components for:
- Sequence Analysis (SeqUtils, SeqIO)
- Oligo Design (DesignOligos)
- Filtering System (multiple filter classes)
- BLAT Processing (PerformBLAT)
- R Interface (Rinterface)

c) Output Layer (Bottom):

##### Detailed Component Breakdown

Core Classes (show as interconnected components):
- Feature/Gene/MetaFeature (data models)
- Sequence/Alignment (sequence handling)
- Various Filters:
- ComplexityFilter
- LowComplexityFilter
- PolybaseFilter
- RepeatFilter

##### Data Flow Indicators

- Sequence data flow from input through processing
- Filter application flow
- External tool interactions
- Result generation flow

##### Technical Details

- Java SE-14 requirement
- R integration points
- BLAT search functionality
- Parallel processing capabilities
- Filter chain implementation

Remember to indicate the parallel processing capabilities and the interaction with external tools (BLAT and R) clearly, as these are crucial aspects of the system's architecture.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef input fill:#a8d1f0,stroke:#333
    classDef processing fill:#90EE90,stroke:#333
    classDef external fill:#FFE5B4,stroke:#333
    classDef output fill:#FFA07A,stroke:#333
    classDef filter fill:#DDA0DD,stroke:#333

    %% Input Layer
    subgraph InputLayer
        FASTA["Target FASTA Files"]:::input
        DB["Database FASTA Files"]:::input
        GTF["GTF/GFF Annotations"]:::input
        CONFIG["Configuration Parameters"]:::input
    end

    %% Core Processing Layer
    subgraph CoreProcessing
        SPE["Sequence Processing Engine"]:::processing
        ODS["Oligo Design System"]:::processing
        
        subgraph DataModels
            FM["Feature/MetaFeature"]:::processing
            GN["Gene"]:::processing
            AL["Alignment"]:::processing
        end
        
        subgraph FilterSystem
            OF["Base OligoFilter"]:::filter
            CF["ComplexityFilter"]:::filter
            LCF["LowComplexityFilter"]:::filter
            PBF["PolybaseFilter"]:::filter
            RF["RepeatFilter"]:::filter
        end
        
        subgraph ExternalTools
            BLAT["BLAT Integration"]:::external
            R["R Interface"]:::external
            RS["R Scripts"]:::external
        end
        
        PP["Parallel Processing"]:::processing
    end

    %% Output Layer
    subgraph OutputLayer
        OD["Oligo Designs"]:::output
        TF["Temporary Files"]:::output
        LOG["Log Files"]:::output
    end

    %% Relationships
    FASTA --> SPE
    DB --> SPE
    GTF --> SPE
    CONFIG --> SPE
    
    SPE --> FM
    SPE --> GN
    SPE --> AL
    
    FM --> ODS
    GN --> ODS
    AL --> ODS
    
    ODS --> OF
    OF --> |Filter Chain| CF
    CF --> LCF
    LCF --> PBF
    PBF --> RF
    
    RF --> BLAT
    BLAT --> R
    R --> RS
    
    PP --> ODS
    
    ODS --> OD
    ODS --> TF
    ODS --> LOG

    %% Click Events
    click SPE "https://github.com/AlexGa/ProbeSHIFTR/blob/main/src/probeshiftr/SeqUtils.java"
    click ODS "https://github.com/AlexGa/ProbeSHIFTR/blob/main/src/probeshiftr/DesignOligos.java"
    click BLAT "https://github.com/AlexGa/ProbeSHIFTR/blob/main/src/probeshiftr/PerformBLAT.java"
    click R "https://github.com/AlexGa/ProbeSHIFTR/blob/main/src/probeshiftr/Rinterface.java"
    click RS "https://github.com/AlexGa/ProbeSHIFTR/blob/main/bin/scripts/callableRscript.R"
    click FM "https://github.com/AlexGa/ProbeSHIFTR/blob/main/src/probeshiftr/MetaFeature.java"
    click GN "https://github.com/AlexGa/ProbeSHIFTR/blob/main/src/probeshiftr/Gene.java"
    click AL "https://github.com/AlexGa/ProbeSHIFTR/blob/main/src/probeshiftr/Alignment.java"
    click OF "https://github.com/AlexGa/ProbeSHIFTR/blob/main/src/probeshiftr/OligoFilter.java"
    click CF "https://github.com/AlexGa/ProbeSHIFTR/blob/main/src/probeshiftr/ComplexityFilter.java"
    click LCF "https://github.com/AlexGa/ProbeSHIFTR/blob/main/src/probeshiftr/LowComplexityFilter.java"
    click PBF "https://github.com/AlexGa/ProbeSHIFTR/blob/main/src/probeshiftr/PolybaseFilter.java"
    click RF "https://github.com/AlexGa/ProbeSHIFTR/blob/main/src/probeshiftr/RepeatFilter.java"
    click PP "https://github.com/AlexGa/ProbeSHIFTR/blob/main/src/probeshiftr/kmerHashCallable.java"

    %% Legend
    subgraph Legend
        I["Input"]:::input
        P["Processing"]:::processing
        E["External Tools"]:::external
        F["Filters"]:::filter
        O["Output"]:::output
    end
```
