Skip to content

on_boarding.md

Latest commit

 

History

History
36 lines (21 loc) · 2.45 KB

on_boarding.md

File metadata and controls

36 lines (21 loc) · 2.45 KB
graph LR
    CLI_Interface["CLI Interface"]
    G2P_API_Client["G2P API Client"]
    CLI_Interface -- "invokes" --> G2P_API_Client
    click CLI_Interface href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main//g2papi/CLI Interface.md" "Details"
    click G2P_API_Client href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main//g2papi/G2P API Client.md" "Details"
Loading

CodeBoardingDemoContact

Component Details

This architecture describes a command-line interface (CLI) application that interacts with an external G2P (Gene to Protein) API. The main flow involves the CLI parsing user commands and arguments, then invoking the appropriate functions within the G2P API Client to fetch and process biological data such as gene, transcript, and protein isoform structures, or protein features. The processed data is then typically outputted to the user.

CLI Interface

Provides the command-line interface for the g2papi application, parsing user arguments and orchestrating calls to the G2P API Client based on the commands issued. It serves as the primary entry point for users to interact with the system.

Related Classes/Methods:

G2P API Client

Encapsulates the logic for interacting with an external G2P API. It handles making HTTP requests to retrieve gene, transcript, and protein isoform structures, as well as protein features, and processes the received data (e.g., CSV parsing).

Related Classes/Methods:

FAQ