nrnb / GoogleSummerOfCode

Main documentation site for NRNB GSoC project ideas and resources
114 stars 38 forks source link

GPML support in Newt #227

Closed hasanbalci closed 2 months ago

hasanbalci commented 5 months ago

Background

Newt [1] is a Cytoscape.js [2] based, open source viewer and editor for pathways in Systems Biological Graphical Notation (SBGN) [3] and Simple Interaction Format (SIF). It's been built (with partial support from GSoC) around an editing library named ChiSE, which in turn was based on a viewer library named SBGNViz [4]. The tool uses a number of Cytoscape.js extensions built for various editing capabilities such as grid-guidelines, context-menus, and expand-collapse.

GPML (Graphical Pathway Markup Language) is the file format used to store pathway content at WikiPathways [5]. It is a custom XML format compatible with pathway visualization and analysis tools such as PathVisio [6] and Cytoscape. Currently, biological maps in GPML format can be created only with PathVisio which is a desktop application or via conversion from other formats such as SBGN and SBML by using Minerva converters.

[1] H. Balci et al., "Newt: a comprehensive web-based tool for viewing, constructing, and analysing biological maps", Bioinformatics, 37(10), pp.1475-1477, 2021. [2] M. Franz et al. "Cytoscape. js 2023 update: a graph theory library for visualization and analysis.", Bioinformatics 39.1, btad031, 2023. [3] N. Le Novère et al., "The Systems Biology Graphical Notation", Nature Biotechnology, 27, pp. 735-741, 2009. [4] M. Sari et al., "SBGNViz: a tool for visualisation and complexity management of SBGN process description maps", PLoS ONE, 10(6), e0128985, 2015. [5] A Agrawal et al. "WikiPathways 2024: next generation pathway database", Nucleic Acids Research 52.D1, pp. D679-D689, 2024. [6] M. Kutmon et al., "PathVisio 3: An Extendable Pathway Analysis Toolbox", PLoS Comput. Biol. 11(2): e1004085, 2015.

Goal

The goal of this project is to add new functionalities to Newt to be able to create biological maps in GPML format from scratch or edit existing ones. This will provide users to have a web-based alternative to PathVisio where they can easily create/edit GPML maps from any computer with Internet access. The functionalities to be added will also include access to WikiPathways, easy identifier mapping and data visualization etc., as in PathVisio.

Difficulty Level: Hard

This project will consist of roughly the following steps, requiring knowledge of different programming languages, libraries and tools:

Size and Length of Project

Skills

Essential skills: JavaScript, HTML, CSS, Java, Cytoscape.js, GPML Nice to have skills: SBGNViz, ChiSE, PathVisio

Public Repository

Newt GitHub repository ChiSE GitHub repository SBGNViz.js GitHub repository

Potential Mentors

Hasan Balci Martina Summer-Kutmon

SainiAditya1 commented 4 months ago

Hey @hasanbalci @mkutmon , I am keen on contributing to this issue as I have proficiency in JavaScript, Java,Cytoscape.js, HTML, and CSS. I am confident that I can provide valuable insights and assist in resolving it. Could you please direct me to the appropriate Slack , Discord channel or any other medium of the organization? This way, I can address any queries I have regarding this issue.

harshikagoyal14 commented 3 months ago

Hey @hasanbalci @mkutmon I am proficient in JavaScript and this project aligns well with my interests. Can you please assign this issue to me

hasanbalci commented 3 months ago

The contributor application period is March 18 – April 2. Here are some useful links:

GSoC contributor guide NRNB project proposal template Eligibility requirements Full program timeline

khanspers commented 2 months ago

This is an active GSoC 2024 project. Closing this project idea as it is no longer available to other contributors.