Miladeb77/Y2_Genepanel_project

Develop a Script to Extract and Integrate PanelApp API Data

Open

#1 opened on Nov 13, 2024

 (3 comments) (0 reactions) (2 assignees)Python (1 fork)auto 404
backendgood first issuesprint1

Repository metrics

Stars
 (0 stars)
PR merge metrics
 (PR metrics pending)

Description

Trello board: https://trello.com/b/WAMAUQjB/stp-year2-software-eng-project

Implement a script to efficiently extract and compile comprehensive data from the PanelApp API, focusing on retrieving panel-specific information and organizing it into a structured database. This functionality should be designed to seamlessly integrate with Flask to enable easy data retrieval and display on a web interface.

Requirements:

Connect to the PanelApp API, managing pagination as needed. Retrieve data from various panels, capturing key attributes such as relevant disorders, associated genes, phenotypes, and evidence levels. Structure the data into a well-organized database format, ensuring efficient access and querying. Implement robust error handling and data validation for smooth API interactions. Enable the output to be used in Flask for dynamic data presentation and easy access through a user-friendly interface. This feature will provide a foundational script and Flask-compatible setup for analyzing and utilizing panel-based genetic data, supporting further development in genetic research applications.

Resources Utilised: PanelApp API Documentation: https://panelapp.genomicsengland.co.uk/api/docs/

Used to understand the API structure, endpoints, and data retrieval methods.

Panelapp Integration Tutorial Tutorial

Used as a reference for integrating API data into a Flask-based web interface. argparse Documentation: Python Argparse Library

Used to implement a flexible command-line interface for configuring the script.

Contributor guide