Giter Club home page Giter Club logo

croco's Introduction

CroCo

made-with-python GitHub tag Github all releases

CroCo converts multiple data format from cross-linking mass spectrometry software tools to xTable format (in csv format).

Important links

You can find the latest release including compiled versions at https://github.com/cschmidtlab/CroCo/releases/latest/.

The full documentation for Croco is available at https://cschmidtlab.github.io/CroCo/.

Supported formats

Currently the following input formats are supported:

Input files can be converted into different formats typically used for analysis of cross-linking data (e.g. visualisation, spectra annotation, ...). The following formats are supported:

CroCo is distributed as graphical program to be run from an executable and as a Python module to be integrated into workflows.

System requirements

For the GUI:

  • Windows 10

For the Python module:

  • Python3 with the following modules installed
    • pandas
    • numpy
    • re

Usage

For the conversion of data of every input program, a slightly different usage is required for gathering all data that are required for xTable. In general, information that is not present in the input files will be asked from the user.

Input formats

Kojak

  • Load file(s): e.g. FILENAME.kojak.txt
  • Provide: Rawfile title (e.g. FILENAME.raw)

Kojak & Percolator

For this script to work, the unpercolated Kojak file (e.g. FILENAME.kojak.txt) has to be in the same directory as the percolated file.

  • Load file(s): e.g. FILENAME.validated.txt
  • Provide: Rawfile title (e.g. FILENAME.raw)

StavroX

  • Load file(s): StavroX results file (e.g. FILENAME.csv)
  • Provide: Path to SSF-file

Xi

  • Load file(s): Path to Xi results file (e.g. FILENAME_XiVersion1.6.739.csv)

Xi & XiFDR

  • Load file(s): Path to xiFDR file (e.g. FILENAME_5_FDR_PSM_xiFDR1.0.22.csv)
  • Provide: Path to corresponding Xi results file (e.g. FILENAME_XiVersion1.6.739.csv)

pLink1

  • Load file(s) (folder): sample folder within the pLink results dir (e.g. 2.report\sample1)

pLink2

  • Load file(s) (folder): reports folder within the pLink results (e.g. pLink_task_2018.06.12.09.33.10\reports)

xQuest

  • Load file(s): xQuest results file exported as csv (e.g. FILENAME_xquest.csv)

Output formats

DynamXL

  • Write to: Directory in which to save the DynamXL file

customTable

  • Write to: Directory in which to save the customTable csv file
  • Provide: customTable template file
customTable Format
[header]
Protein 1, Protein 2
[data]
[prot1], [prot2]
[footer]
This is the footer of the file
  • Everything between [header] and [data] is considered the header and is printed once on top of the output file
  • In the [data] block columns identified by their xTable header are written in substitution of the header name.
    • E.g. instead of [prot1], [prot2] a line like SPA_STAAU, IgG4_heavy is written for every line in the xTable file
    • Everything not enclosed in brackets will be written as is
    • If an invalid header name is given in brackets, the program will stop

pLabel

  • Write to: Directory in which to save the pLabel file
  • Provide: Directory containing the corresponding mgf-files
    • The mgf filenames must match the rawfile names given in the xTable

xTable

  • Write to: Directory in which to save xTable file

xVis

  • Write to: Directory in which to save xVis file

xWalk

  • Write to: Directory in which to save xWalk file
  • Provide:
    • PDB to map xlinks: Name of a PDB file that should be analysed by xWalk
    • PDB Atom code (Text): A PDB atom code (e.g. CB) that should be used for distance calculation

xiNet

  • Write to: Directory in which to save xiNez file

Version History

0.5

  • customTable support

0.4

  • Added pLabel support
  • Options Window on GUI

croco's People

Contributors

aretaon avatar

Stargazers

Karl Makepeace avatar

Watchers

James Cloos avatar  avatar

Forkers

aretaon

croco's Issues

pLabel multiple annotations

pLink sometimes adds multiple annotations to a spectrum. The CroCo Converter now just takes the first annotation for pLabel export so that a potentially better solution for a spectrum is lost.

Force pLabel xlinker

Force user to enter a label for the xlinker as no label will lead to errors with pLabel in any case

pLabel scanno substring match

If a scan (e.g. 2561) is matched to an mgf file, matching can occur to larger scannumbers with the same substring (e.g. 25614)!

pLink1 Modifications bug

xTable from pLink1 leads to a too small value (-1) for modifications2.
Recheck calculation of modifications2

Kojak and Kojak & Percolator

Converting from Kojak results in ['modmass1', 'modpos1', 'modmass2', 'modpos2'] not in index.
Calculate these from the Kojak input!

pLabel Merge Error

When using pLabel merge mgf files, the resulting pLabel file contains an error in xlink position numbering.
(pLabel references to a position that is larger than the peptide length)

Multiple files input StavroX

Select multiple csv files from StavroX and concatenate them into one xTable.
Use the same ssf file for all csv-files.

Check pLink input file

Commas in protein file names cause failure of reading pLink CSV files.
Add a file checker or a useful error message for this case.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.