Developer guide

Getting started

• Adding a new module
  • Naming convention
  • Programmatic structure
  • Checklist
• Development setup
  • Local installation
  • Unit tests
  • Testing the web interface locally
  • Documentation
• How to contribute
• Release workflow
• Local usage
• Modifying an existing module

Python API

• ProteoBench package
  • Template
    • Template for module
  • Modules
    • DDA_Quant
• Web interface
  • Interactive app with pages for the different benchmarking cases

Organization

The ProteoBench project is divided into two main parts:

Modules for Data Processing and Reporting

These developer-guide/api/proteobench/modules/index process the data and generate reports.

Web Interface for Result Visualization

The developer-guide/api/webinterface/index displays the results and allows comparison with publicly available data.