API Reference ============= This section provides comprehensive API documentation for all modules in elsheeto. Facade Functions ---------------- The facade module provides convenient functions for parsing sample sheets without dealing with the internal parsing stages. .. automodule:: elsheeto.facade :members: :undoc-members: :show-inheritance: Models ------ Data Models - Common ~~~~~~~~~~~~~~~~~~~~ .. automodule:: elsheeto.models.common :members: :undoc-members: :show-inheritance: Data Models - Utils ~~~~~~~~~~~~~~~~~~~~ .. automodule:: elsheeto.models.utils :members: :undoc-members: :show-inheritance: Data Models - Stage 1 (Raw CSV) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: elsheeto.models.csv_stage1 :members: :undoc-members: :show-inheritance: Data Models - Stage 2 (Structured) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: elsheeto.models.csv_stage2 :members: :undoc-members: :show-inheritance: Data Models - Illumina v1 ~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: elsheeto.models.illumina_v1 :members: :undoc-members: :show-inheritance: Data Models - Aviti ~~~~~~~~~~~~~~~~~~~ .. automodule:: elsheeto.models.aviti :members: :undoc-members: :show-inheritance: Parsers ------- Parser - Common ~~~~~~~~~~~~~~~ .. automodule:: elsheeto.parser.common :members: :undoc-members: :show-inheritance: Parser - Stage 1 (Raw CSV) ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: elsheeto.parser.stage1 :members: :undoc-members: :show-inheritance: Parser - Stage 2 (Structured) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: elsheeto.parser.stage2 :members: :undoc-members: :show-inheritance: Parser - Illumina v1 ~~~~~~~~~~~~~~~~~~~~ .. automodule:: elsheeto.parser.illumina_v1 :members: :undoc-members: :show-inheritance: Parser - Aviti ~~~~~~~~~~~~~~ .. automodule:: elsheeto.parser.aviti :members: :undoc-members: :show-inheritance: Exceptions ---------- .. automodule:: elsheeto.exceptions :members: :undoc-members: :show-inheritance: