on_boarding.md

graph LR
    Core_Module["Core Module"]
    Authentication_Authorization_Module["Authentication & Authorization Module"]
    Data_Access_API_Layer["Data Access & API Layer"]
    Dataset_Management_Module["Dataset Management Module"]
    User_Administration_Module["User & Administration Module"]
    Shared_UI_Utility_Module["Shared UI & Utility Module"]
    Feature_Modules["Feature Modules"]
    User_Preferences_Saved_State_Module["User Preferences & Saved State Module"]
    Core_Module -- "interacts with" --> Authentication_Authorization_Module
    Data_Access_API_Layer -- "uses" --> Authentication_Authorization_Module
    Data_Access_API_Layer -- "provides data to" --> Feature_Modules
    Data_Access_API_Layer -- "consumes context from" --> Dataset_Management_Module
    Dataset_Management_Module -- "interacts with" --> User_Administration_Module
    User_Administration_Module -- "uses" --> Authentication_Authorization_Module
    Feature_Modules -- "consume reusable UI components from" --> Shared_UI_Utility_Module
    User_Preferences_Saved_State_Module -- "uses" --> Data_Access_API_Layer
    click Core_Module href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/gpfjs/Core_Module.md" "Details"
    click User_Administration_Module href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/gpfjs/User_Administration_Module.md" "Details"
    click Feature_Modules href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/gpfjs/Feature_Modules.md" "Details"
    click User_Preferences_Saved_State_Module href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/gpfjs/User_Preferences_Saved_State_Module.md" "Details"

Loading

Details

The GPF (Genotypes and Phenotypes in Families) project is an Angular-based web application designed for exploring and analyzing genomic and phenotypic data.

Core Module [Expand]

The foundational layer responsible for application bootstrapping, global configuration, and managing application-wide concerns like loading states.

Related Classes/Methods:

• app.app.component.AppComponent
• app.app.module.AppModule
• app.instance.service.InstanceService
• app.config.config.service.ConfigService
• app.fullscreen_loading.fullscreen_loading.service.FullscreenLoadingService

Authentication & Authorization Module

Manages user login, session management, token handling, and secures application routes and API calls.

Related Classes/Methods:

• app.auth.service.AuthService
• app.auth_interceptor.service.AuthInterceptorService

Data Access & API Layer

Centralizes all communication with the backend API, handling data requests, responses, and potentially caching. Acts as the single source of truth for data retrieval.

Related Classes/Methods:

• app.query.query.service.QueryService

Dataset Management Module

Handles the retrieval, caching, and provision of dataset-specific information, including hierarchical structures and metadata, and manages dataset permissions.

Related Classes/Methods:

• app.datasets.datasets.service.DatasetsService
• app.datasets.datasets_tree.service.DatasetsTreeService
• app.datasets.datasets.component.DatasetsComponent
• app.dataset_node.dataset_node.component.DatasetNodeComponent
• app.dataset_description.dataset_description.component.DatasetDescriptionComponent
• app.datasets_table.datasets_table.component.DatasetsTableComponent

User & Administration Module [Expand]

Manages user accounts, groups, permissions, and related administrative functionalities.

Related Classes/Methods:

• app.users.users.service.UsersService
• app.user_management.user_management.component.UserManagementComponent
• app.groups_table.groups_table.component.GroupsTableComponent
• app.federation_credentials.federation_credentials.component.FederationCredentialsComponent
• app.users_groups.users_groups.service.UsersGroupsService

Shared UI & Utility Module

Contains reusable UI components (e.g., filters, buttons, data visualizations) and common utility services that are used across multiple feature modules.

Related Classes/Methods:

• app.person_filters.person_filters.component.PersonFiltersComponent
• app.regions_block.regions_block.component.RegionsBlockComponent
• app.gene_plot.gene_plot.component.GenePlotComponent
• app.histogram.histogram.component.HistogramComponent
• app.pedigree_chart.pedigree_chart.component.PedigreeChartComponent

Feature Modules [Expand]

A collection of specialized modules providing core application functionalities for exploring and analyzing genomic and phenotypic data (e.g., Genotype Browser, Gene Browser, Phenotype Tool, Enrichment Tool, Gene Profiles, Variant Reports).

Related Classes/Methods:

• app.genotype_browser.genotype_browser.component.GenotypeBrowserComponent
• app.gene_browser.gene_browser.component.GeneBrowserComponent
• app.pheno_browser.pheno_browser.component.PhenoBrowserComponent
• app.pheno_tool.pheno_tool.component.PhenoToolComponent
• app.enrichment_tool.enrichment_tool.component.EnrichmentToolComponent
• app.gene_profiles_block.gene_profiles_block.component.GeneProfilesBlockComponent
• app.variant_reports.variant_reports.component.VariantReportsComponent

User Preferences & Saved State Module [Expand]

Manages the persistence and retrieval of user-defined query configurations and user profile settings.

Related Classes/Methods:

• app.save_query.save_query.component.SaveQueryComponent
• app.load_query.load_query.component.LoadQueryComponent
• app.saved_queries_table.saved_queries_table.component.SavedQueriesTableComponent
• app.user_profile.user_profile.component.UserProfileComponent

FAQ