CutePeaks

CutePeaks: A modern viewer for Sanger trace file - Published in JOSS (2021)

https://github.com/labsquare/cutepeaks

Science Score: 98.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 7 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

ab1 sanger-chromatograms scf

Scientific Fields

Biology Life Sciences - 40% confidence
Last synced: 4 months ago · JSON representation ·

Repository

CutePeaks is a standalone Sanger trace viewer steered by a modern and user-friendly UI.

Basic Info
Statistics
  • Stars: 45
  • Watchers: 12
  • Forks: 17
  • Open Issues: 29
  • Releases: 5
Topics
ab1 sanger-chromatograms scf
Created almost 9 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing Funding License Code of conduct Citation Authors

README.md

CutePeaks

C/C++ CI DOI DOI

https://labsquare.github.io/CutePeaks/

A simple viewer for Sanger trace file made with Qt5. Supports AB1 and SCF 3.0 file formats. It has regular expression pattern finder and can export trace as SVG vector image.

Preview

Statement of need

Despite the major use of Next Generation Sequencing, the Sanger method is still widely used in genetic labs as the gold standard to read target DNA sequences. Very few opensource software is available to explore Sanger trace data and most of labs staff still rely on proprietary software. Moreover, they are not always user-friendly and lack modern look and feel.

State of field

4peaks is a software widely used by biologists that benefits from a nice User interface. Sadly, it is only available on MacOS and source code is not opened to community enhancement. Seqtrace is the only standalone and opensource application we could find. However, it is written with GTK framework in Python 2, the latter being deprecated and slower than C++.

Installation

Windows

Download windows binary

MacOSX

Downlad MacOS binary

Linux

AppImage

Linux binary is available as AppImage. Download the AppImage from here. For ubuntu >=21.04, Download this one here

Run it as follow:

chmod +x cutepeaks-0.2.0-linux-x86_64.appimage
./cutepeaks-0.2.0-linux-x86_64.appimage

FlatPak

Cutepeaks is available as a flatpak

flatpak install flathub io.github.labsquare.CutePeaks flatpak run io.github.labsquare.CutePeaks

Compilation

Prerequisites

Install Qt ≥ 5.7

From website: Download Qt ≥ 5.7 from https://www.qt.io/. Don't forget to check QtChart module during installation.

From Ubuntu: Qt 5.7 is not yet available with Ubuntu. But you can add a PPA to your software system. For exemple for Xenial:

sudo add-apt-repository ppa:beineri/opt-qt57-xenial
sudo apt install qt57base qt57charts-no-lgpl
source /opt/qt57/bin/qt57-env.sh

From Fedora: Qt 5.7 is available.

sudo dnf install qt5-qtbase-devel qt5-qtcharts-devel

Compile CutePeaks

Be sure you have the correct version of Qt (≥ 5.7) by using qmake --version. For exemple, if you have installed Qt from ppa:beineri, you will find it under /opt/qt57/bin/qmake. Then launch the compilation from CutePeaks folder as follow.

 /opt/qt57/bin/qmake --version
 /opt/qt57/bin/qmake
 make
 sudo make install

Usage

CutePeaks supports following trace file formats:

  • *.ab1
  • *.scf

Example files are available here: https://github.com/labsquare/CutePeaks/tree/master/examples
You can open those files from cutepeaks by clicking on open from the File menu.

Features

Once the file is open, cutepeaks allows you to : - Explore the trace from a scroll area. ( Finger geasture are supported with touch screen) - Scale the trace horizontally or vertically using 2 sliders at the bottom right. - Select a subsequence with the mouse as with any text editor. Then you can cut or copy to the clipboard - Make the reverse complement from the edit menu - Display Sequence and metadata from the view menu - Search for a regular expression pattern. Open the "Find Sequence..." from the edit menu - Export trace or sequence to different format. ( e.g: Fasta, CSV, SVG or PNG image )

Contributions / Bugs

See how to contributing

Licenses

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/gpl-3.0.txt.

Owner

  • Name: Labsquare
  • Login: labsquare
  • Kind: organization

Organization for opensource genomics software

JOSS Publication

CutePeaks: A modern viewer for Sanger trace file
Published
August 06, 2021
Volume 6, Issue 64, Page 3457
Authors
Sacha Schutz ORCID
CHRU Brest, Hôpital Morvan, Laboratoire de Génétique Moléculaire, Brest, France, Univ Brest, Inserm, EFS, UMR 1078, GGB, 29200
Charles Monod-Broca ORCID
Univ Brest, Inserm, EFS, UMR 1078, GGB, 29200
Anne-Sophie Denommé-Pichon ORCID
Unité Fonctionnelle Innovation en Diagnostic génomique des maladies rares, FHU-TRANSLAD, CHU Dijon Bourgogne, Dijon, France, UMR1231 GAD, Inserm - Université Bourgogne-Franche Comté, Dijon, France
Editor
Lorena Pantano ORCID
Tags
Python Sanger genetics Qt GUI

Citation (CITATION.cff)

cff-version: 1.1.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Schutz
    given-names: Sacha
    affiliation: CHRU Brest, Hôpital Morvan, Laboratoire de Génétique Moléculaire, Brest, France
    orcid: https://orcid.org/0000-0002-4563-7537
  - family-names: Monod-Broca
    given-names: Charles
    affiliation: Univ Brest, Inserm, EFS, UMR 1078, GGB, 29200
    orcid: https://orcid.org/0000-0003-4095-8099
  - family-names: Denommé-Pichon
    given-names: Anne-Sophie
    affiliation: UMR1231 GAD, Inserm - Université Bourgogne-Franche Comté, Dijon, France
    orcid: https://orcid.org/0000-0002-8986-8222
    
title: 'CutePeaks: A modern viewer for Sanger trace file'
version: 0.2.3
date-released: 2021-07-28
            

GitHub Events

Total
  • Watch event: 2
  • Issue comment event: 2
  • Push event: 1
  • Pull request event: 3
  • Fork event: 1
Last Year
  • Watch event: 2
  • Issue comment event: 2
  • Push event: 1
  • Pull request event: 3
  • Fork event: 1

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 322
  • Total Committers: 10
  • Avg Commits per committer: 32.2
  • Development Distribution Score (DDS): 0.161
Past Year
  • Commits: 5
  • Committers: 1
  • Avg Commits per committer: 5.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
dridk s****a@l****g 270
Anne-Sophie Denommé-Pichon a****o@h****r 18
Charles c****a@n****r 16
Matthias Mailänder m****s@m****e 6
James Aaron Erang i****l@g****m 5
yschutz s****z@i****r 2
Jérémie Roquet j****t@a****t 2
mutterer j****r@g****m 1
The Gitter Badger b****r@g****m 1
Olivier Gueudelot o****r@l****g 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 69
  • Total pull requests: 11
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 1 day
  • Total issue authors: 10
  • Total pull request authors: 7
  • Average comments per issue: 1.04
  • Average comments per pull request: 0.91
  • Merged pull requests: 10
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 11 days
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 1.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • dridk (45)
  • Oodnadatta (12)
  • domenico-somma (4)
  • natir (2)
  • domi84 (1)
  • tnrich (1)
  • ikit (1)
  • Bounoun (1)
  • richardbmx (1)
  • StuntsPT (1)
Pull Request Authors
  • Mailaender (4)
  • Oodnadatta (3)
  • iaacornus (2)
  • ikit (1)
  • gitter-badger (1)
  • mutterer (1)
  • dridk (1)
Top Labels
Issue Labels
enhancement (41) help wanted (6) bug (4) wontfix (4) urgent (2) question (2) duplicate (1)
Pull Request Labels

Dependencies

.github/workflows/c-cpp.yml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v2 composite