# pnnl-comp-mass-spec/protein-sequence-motif-extractor architecture

> Architecture diagram of the GitHub repository pnnl-comp-mass-spec/protein-sequence-motif-extractor, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-25). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/pnnl-comp-mass-spec/protein-sequence-motif-extractor
- Repository: https://github.com/pnnl-comp-mass-spec/protein-sequence-motif-extractor

## Overview

##### Project type and purpose
- This is a small command-line, open-source tool written in VB.NET.
- It reads protein sequences (FASTA or tab-delimited), searches for user-specified motifs (literal or regex), and writes out matching regions in FASTA or tab format.

##### File structure
Top level:
- ProteinSequenceMotifExtractor.sln & .vbproj → Visual Studio solution & project.
- modMain.vb → main entry point, argument parsing & orchestration.
- FastaFileOptionsClass.vb → encapsulates command-line switches (/M, /N, /K, /X, /T).
- clsProteinSequenceMotifExtractor.vb → core motif-search logic.
- AssemblyInfo.vb & app.config → assembly metadata & .NET configuration.
- bin/ → sample input files, example runs, SQL script, and output XML.
- docs/ → Jekyll site for documentation (static site generator).
- ZippedForUpload/ → helper scripts for packaging.

##### README for additional insights
- Describes command-line switches and I/O formats.
- Mentions optional regex mode, flanking-residue padding, output symbol retention.

##### Don’t overthink—capture all logical pieces
- How app.config & optional XML options plug into the CLI Frontend.
- Jekyll docs folder as a separate “Documentation” component.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Layers
    subgraph "Presentation Layer"
        direction TB
        CLI["CLI Frontend\n(parse args, orchestrate flow)"]:::logic
        Options["FastaFileOptionsClass\n(encapsulate/validate switches)"]:::logic
    end

    subgraph "Domain Layer"
        direction TB
        Engine["clsProteinSequenceMotifExtractor\n(motif matching & padding)"]:::logic
    end

    subgraph "Persistence Layer"
        direction TB
        Reader["File Reader\n(read FASTA/tab-delimited)"]:::io
        Writer["File Writer\n(write FASTA/tab-delimited)"]:::io
    end

    subgraph "Configuration"
        direction TB
        AppConfig["app.config\n(.NET settings)"]:::config
        AssemblyInfo["AssemblyInfo.vb\n(metadata)"]:::config
        XMLOpts["XML Options\n(runtime schema)"]:::config
    end

    subgraph "Documentation"
        direction TB
        Docs["docs/\n(Jekyll site)"]:::config
    end

    subgraph "Project Files"
        direction TB
        Solution["ProteinSequenceMotifExtractor.sln"]:::config
        ProjectFile["ProteinSequenceMotifExtractor.vbproj"]:::config
    end

    subgraph "Samples & Packaging"
        direction TB
        Samples["bin/\n(sample I/O & scripts)"]:::io
        ZipScript["UpdateZipFile.bat\n(packaging script)"]:::config
    end

    %% Flow
    CLI -->|"args + config"| Options
    CLI -->|"invoke"| Reader
    Reader -->|"List<Sequence>"| Engine
    Engine -->|"ExtractedMotifs"| Writer
    CLI -->|"write output"| Writer
    CLI -->|"load AppConfig & AssemblyInfo"| AppConfig
    CLI -->|"load AppConfig & AssemblyInfo"| AssemblyInfo
    CLI -->|"optional XML opts"| XMLOpts

    %% Off-runtime
    Docs -.-> Solution

    %% Click Events
    click CLI "https://github.com/pnnl-comp-mass-spec/protein-sequence-motif-extractor/blob/master/modMain.vb"
    click Options "https://github.com/pnnl-comp-mass-spec/protein-sequence-motif-extractor/blob/master/FastaFileOptionsClass.vb"
    click Engine "https://github.com/pnnl-comp-mass-spec/protein-sequence-motif-extractor/blob/master/clsProteinSequenceMotifExtractor.vb"
    click AppConfig "https://github.com/pnnl-comp-mass-spec/protein-sequence-motif-extractor/blob/master/app.config"
    click AssemblyInfo "https://github.com/pnnl-comp-mass-spec/protein-sequence-motif-extractor/blob/master/AssemblyInfo.vb"
    click XMLOpts "https://github.com/pnnl-comp-mass-spec/protein-sequence-motif-extractor/blob/master/bin/ProteinSequenceMotifExtractorOptions.xml"
    click Samples "https://github.com/pnnl-comp-mass-spec/protein-sequence-motif-extractor/tree/master/bin/"
    click Solution "https://github.com/pnnl-comp-mass-spec/protein-sequence-motif-extractor/blob/master/ProteinSequenceMotifExtractor.sln"
    click ProjectFile "https://github.com/pnnl-comp-mass-spec/protein-sequence-motif-extractor/blob/master/ProteinSequenceMotifExtractor.vbproj"
    click Docs "https://github.com/pnnl-comp-mass-spec/protein-sequence-motif-extractor/tree/master/docs/"
    click ZipScript "https://github.com/pnnl-comp-mass-spec/protein-sequence-motif-extractor/blob/master/ZippedForUpload/UpdateZipFile.bat"

    %% Styles
    classDef io fill:#CDE8FF,stroke:#0366D6,color:#0366D6;
    classDef logic fill:#D6F5D6,stroke:#238823,color:#238823;
    classDef config fill:#FFF3CD,stroke:#FFEEBA,color:#856404;
```
