Skip to content

on_boarding.md

Latest commit

 

History

History
99 lines (63 loc) · 8.14 KB

on_boarding.md

File metadata and controls

99 lines (63 loc) · 8.14 KB
Raw
graph LR
    Core_Sequence_Abstraction["Core Sequence Abstraction"]
    SeqLike_Accessor["SeqLike Accessor"]
    Biological_Data_Definitions["Biological Data Definitions"]
    Mutation_Management["Mutation Management"]
    Alignment_Module["Alignment Module"]
    Sequence_Transformation_Visualization["Sequence Transformation & Visualization"]
    Core_Sequence_Abstraction -- "uses" --> Biological_Data_Definitions
    Core_Sequence_Abstraction -- "uses" --> Sequence_Transformation_Visualization
    Core_Sequence_Abstraction -- "uses" --> Mutation_Management
    SeqLike_Accessor -- "uses" --> Core_Sequence_Abstraction
    Alignment_Module -- "uses" --> Core_Sequence_Abstraction
    SeqLike_Accessor -- "uses" --> Alignment_Module
    SeqLike_Accessor -- "uses" --> Biological_Data_Definitions
    SeqLike_Accessor -- "uses" --> Sequence_Transformation_Visualization
    Mutation_Management -- "uses" --> Biological_Data_Definitions
    Alignment_Module -- "uses" --> Biological_Data_Definitions
    Sequence_Transformation_Visualization -- "uses" --> Biological_Data_Definitions
    click Core_Sequence_Abstraction href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/seqlike/Core_Sequence_Abstraction.md" "Details"
    click SeqLike_Accessor href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/seqlike/SeqLike_Accessor.md" "Details"
    click Biological_Data_Definitions href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/seqlike/Biological_Data_Definitions.md" "Details"
    click Mutation_Management href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/seqlike/Mutation_Management.md" "Details"
    click Alignment_Module href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/seqlike/Alignment_Module.md" "Details"
    click Sequence_Transformation_Visualization href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/seqlike/Sequence_Transformation_Visualization.md" "Details"
Loading

CodeBoardingDemoContact

Details

The seqlike library is structured around a core sequence abstraction, extended by specialized modules for advanced analysis, external tool integration, and data transformation. The architecture emphasizes modularity, clear separation of concerns, and a centralized approach to biological data definitions.

Core Sequence Abstraction [Expand]

This central component defines the fundamental representation and manipulation of individual biological sequences (DNA, RNA, Protein). It provides core functionalities such as initialization from various formats, type conversion (e.g., nucleotide to amino acid), reverse complementation, ungapping, slicing, and basic sequence arithmetic. It also encapsulates general sequence manipulation and validation routines, serving as the primary data carrier and foundational operation hub within the library.

Related Classes/Methods:

SeqLike Accessor [Expand]

This component extends the capabilities of the Core Sequence Abstraction, specifically designed for handling collections of sequences, such as multiple sequence alignments. It provides an ergonomic interface for advanced data analysis, including calculating sequence counts, generating consensus sequences, performing one-hot encoding on collections, and integrating with visualization tools for collective sequence data.

Related Classes/Methods:

Biological Data Definitions [Expand]

This component centralizes the definition and validation of various biological alphabets (e.g., DNA, RNA, Protein, ambiguous characters) and manages genetic code tables. It provides essential utilities to check sequence types, ensure data consistency with respect to expected biological character sets, and facilitate accurate translation between nucleotide and amino acid sequences.

Related Classes/Methods:

Mutation Management [Expand]

This component is responsible for the representation, parsing, and management of individual sequence mutations (Mutation) and collections of mutations (MutationSet). It provides functionalities crucial for tracking, applying, and analyzing sequence changes within biological contexts.

Related Classes/Methods:

Alignment Module [Expand]

This module provides a unified interface for integrating and executing external multiple sequence alignment tools (e.g., MAFFT, MUSCLE). It abstracts away command-line complexities and offers helper functions for post-processing aligned sequences, including tasks like aligning letter annotations and ensuring consistency across alignments.

Related Classes/Methods:

Sequence Transformation & Visualization [Expand]

This component handles the conversion of biological sequences into various numerical or symbolic representations, such as arrays or one-hot encodings, which is essential for integration with machine learning models or numerical analysis pipelines. Additionally, it provides utilities for visualizing sequence data, including generating graphical representations like WebLogos and rendering alignments with custom color schemes to enhance data interpretability.

Related Classes/Methods:

FAQ