Science Score: 57.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 2 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.6%) to scientific vocabulary
Last synced: 8 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: lfnothias
  • License: gpl-3.0
  • Default Branch: main
  • Size: 2.14 MB
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created about 4 years ago · Last pushed over 4 years ago
Metadata Files
Readme Changelog License Citation

README.md

Taxonomically Informed Metabolite Annotation

The initial work is available at https://doi.org/10.3389/fpls.2019.01329, and many improvements have been made since then. The workflow is illustrated in Figure 1.

Figure 1

This repository contains everything needed to perform Taxonomically Informed Metabolite Annotation.

It is provided with an example from well-known pharmacopoeia plants.

Here is what you minimally need:

  • A feature list with or without candidate annotations, if you are using GNPS, it can be your GNPS job ID.
  • The source organism of the extract you are annotating, if you are associating metadata within GNPS, it can be your GNPS job ID.
  • An edge list, if you are using GNPS, it can be your GNPS job ID.

Optionally, you may want to add:

  • An in-house structure-organism pairs library (we provide LOTUS as starting point for each user)
  • Your own manual or automated annotations (we currently support annotations coming from ISDB and SIRIUS)

Repo preparation

shell git clone git@github.com:taxonomicallyinformedannotation/tima-python.git cd tima-python

Windows Notice

If you are using Windows, you will need to install Choco.

Then run:

shell choco install curl choco install gzip choco install unzip choco install wget

Please also follow the procedure described here to ensure files will be proberly encoded.

To run in docker:

shell docker build -t tima-python . # optional docker run -it --rm -v $PWD:/app tima-python

To run locally:

shell conda env create -f environment.yml && conda activate tima-python

Copy initial parameters

```shell

copy the default params to adapat to your data later on

cp -R config/default config/params ```

Structure-organism pairs library

```shell bash src/getlotus.sh && python src/preparelotus.py &&

python prepare_closed.py && # only if you have access to it

python src/preparelibrary.py && python src/prepareadducts.py && ```

Annotations

Get MS2 annotations

```shell

normally it would be 'python src/process_spectra.py' but for now we have to think about it.

instead we provide an example file coming from the new ISDB.

It also works with annotations coming from GNPS (see next steps)

bash src/getexampleisdb.sh ```

Format MS2 annotations

```shell

depending on the annotation tool you used

python src/preparegnps.py && # optional python src/prepareisdb.py ```

Complement MS2 annotations (with spectral clusters and chemical taxonomy of annotations)

shell python src/prepare_edges.py && python src/prepare_features_components.py && python src/prepare_features_classification.py

Get biological taxonomy information

shell bash src/get_gnverifier.sh && python src/prepare_taxa.py

And finally the graal!

NOT READY YET

```shell

python process_annotations.py

```

NOTE: you can use --help or -h argument for all .py steps to get more info

Owner

  • Login: lfnothias
  • Kind: user
  • Company: University of Geneva

Metabolomics - Computational metabolomics - Multi-omics

Citation (CITATION.cff)

cff-version: 1.2.0
message: "Please cite the following works when using this software."
authors:
  - family-names: Rutz
    given-names: Adriano
    orcid: https://orcid.org/0000-0003-0443-9902
  - family-names: Bisson
    given-names: Jonathan
    orcid: https://orcid.org/0000-0003-1640-9989
  - family-names: Allard
    given-names: Pierre-Marie
    orcid: https://orcid.org/0000-0003-3389-2191
title: Taxonomically Informed Scoring Enhances Confidence in Natural Products Annotation
url: "https://github.com/taxonomicallyinformedannotation/tima-python"
preferred-citation:
  type: article
  authors:
  - family-names: Rutz
    given-names: Adriano
    orcid: https://orcid.org/0000-0003-0443-9902
  - family-names: Dounoue-Kubo
    given-names: Miwa
  - family-names: Ollivier
    given-names: Simon
    orcid: https://orcid.org/0000-0002-7671-1736
  - family-names: Bisson
    given-names: Jonathan
    orcid: https://orcid.org/0000-0003-1640-9989
  - family-names: Bagheri
    given-names: Mohsen
  - family-names: Saesong
    given-names: Tongchai
  - family-names: Ebrahimi
    given-names: Samad Nejad
    orcid: https://orcid.org/0000-0003-2167-8032
  - family-names: Ingkaninan
    given-names: Kornkanok
    orcid: https://orcid.org/0000-0002-4415-8489
  - family-names: Wolfender
    given-names: Jean-Luc
    orcid: https://orcid.org/0000-0002-0125-952X
  - family-names: Allard
    given-names: Pierre-Marie
    orcid: https://orcid.org/0000-0003-3389-2191
  title: Taxonomically Informed Scoring Enhances Confidence in Natural Products Annotation
  year: 2019
  journal: Frontiers in Plant Science
  volume: 10
  doi: 10.3389/fpls.2019.01329
  url: "http://dx.doi.org/10.3389/fpls.2019.01329"
  identifiers:
    - type: "doi"
      value: "10.3389/fpls.2019.01329"
    - type: "url"
      value: "http://dx.doi.org/10.3389/fpls.2019.01329"
    - type: "other"
      value: "urn:issn:1664-462X"

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/codeql-analysis.yml actions
  • actions/checkout v2 composite
  • github/codeql-action/analyze v1 composite
  • github/codeql-action/autobuild v1 composite
  • github/codeql-action/init v1 composite
.github/workflows/tima.yaml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • conda-incubator/setup-miniconda v2 composite
  • s-weigand/setup-conda v1 composite
.github/workflows/versioning.yml actions
  • ./ * composite
  • actions/checkout v2 composite
environment.yml conda
  • docopt
  • pandas
  • pyyaml
Dockerfile docker
  • continuumio/miniconda3 latest build
setup.py pypi
  • docopt *
  • eg *
  • numpy *
  • pandas *
  • pyyaml *
  • six >=1.7