Skip to content

Latest commit

 

History

History
151 lines (134 loc) · 12.3 KB

README.md

File metadata and controls

151 lines (134 loc) · 12.3 KB

DOI Javadoc License: MIT Maintenance build GitHub issues GitHub contributors GitHub release Maven Central Quality Gate StatusSoftware article - JChemInf GitHub wiki

SRU_logo

Sugar Removal Utility (SRU)

An algorithmic approach for in silico removal of circular and linear sugars from molecular structures

Contents of this document

Overview

  • The Sugar Removal Utility (SRU), an algorithmic approach for in silico removal of circular and linear sugars from molecular structures, is described in this scientific publication: Schaub, J., Zielesny, A., Steinbeck, C. et al. Too sweet: cheminformatics for deglycosylation in natural products. J Cheminform 12, 67 (2020). There, you can find all necessary details about the algorithm and its various configuration options. We also published a follow-up article where we used the SRU to analyse sugar moieties in the Collection of Open Natural products (COCONUT) database.
  • This repository used to host the SRU source code, but it has now moved to the Chemistry Development Kit (CDK) Java library for cheminformatics. If you want to use the SRU as a Java library, you now need to use the CDK version 2.10 or higher. Information on how to install and use the CDK can be found in the GitHub repository linked above. You can then use the SRU via CDK's SugarRemovalUtility class.
  • This repository now only hosts the SRU command-line application and its source code and it serves as a place for documentation about the algorithm.
  • The SRU's functionalities can also be used in other software tools:
  • Every software tool listed above is open and free (of charge) to use!
  • The repository wiki contains code examples and some additional notes on sugar moiety detection and removal using the SRU.

Contents of this repository

Sources

The sources available in /src/main/java/de/unijena/cheminf/deglycosylation/ belong to the SRU command-line application. It makes the various settings for fine-tuning the sugar detection and removal process available through command-line arguments. But using the CDK SugarRemovalUtility class directly in your own software project offers some additional configuration options and functionalities:

  • Adding and removing circular and linear sugar patterns for the initial detection steps
  • Sugar detection without removal
  • Detecting only the number of sugar moieties of a molecule

The class SugarRemovalUtilityTest can be found in the directory /src/test/java/de/unijena/cheminf/deglycosylation/. It is a JUnit test class that tests the performance of the Sugar Removal Utility on multiple specific molecular structures of natural products hand-picked from public databases (see article linked above). Code examples of how to use and configure the SugarRemovalUtility class can be found here.

SugarRemovalUtility CMD App

The sub-folder "SugarRemovalUtility CMD App" contains the sugar removal command-line application downloadable as Java archive. The JAR file "SugarRemovalUtility-jar-with-dependencies.jar" can be executed from the command-line using Java version 17 or higher. A detailed explanation how to use the application can be found in "Usage instructions.txt". Also, an example input file is provided, named "smiles_test_file.txt".

Natural product test sets

The test resources folder contains the review_glycosylated_NPs_bacteria_data.sdf file which was published and provided by Elshahawi et al. (2015) and contains bacterial glycosylated natural products used for testing the SRU algorithm (see SRU paper linked above).
The text file "hand_picked_np.txt" contains a list of SMILES codes serving as a natural product test set for the performance of the Sugar Removal Utility. They were hand-picked from public databases via the COlleCtion of Open NatUral producTs (COCONUT). More details can be found in the test class (see below) and the Sugar Removal Utility publication.

Installation

As stated above, the Sugar Removal Utility is now part of the Chemistry Development Kit. So, if you are already using CDK, you do not need to install the SRU externally, you can use it via CDK's SugarRemovalUtility class. If not, please follow the installation description in the CDK repository linked above.
The Sugar Removal Utility web applcation in this repository is hosted as a package/artifact on the sonatype maven central repository. See the artifact page for installation guidelines using build tools like maven or gradle. To install it via its JAR archive, you can get it from the releases. Note that other dependencies will need to be installed via JAR archives as well this way.

Command line application JAR

The command-line application JAR has to be downloaded. After that, it can be executed from the command-line as described in the usage instructions. Java version 17 or higher has to be installed on your machine.

Source code

This is a Maven project. In order to use the source code for your own software, download or clone the repository and open it in a Maven-supporting IDE (e.g. IntelliJ) as a Maven project and execute the pom.xml file. Maven will then take care of installing all dependencies.

Dependencies

Needs to be pre-installed:

  • Java Development Kit (JDK) version 17 or higher
    • Adoptium OpenJDK (as one possible source of the JDK)
    • Eclipse Public License v2.0
  • Apache Maven version 4

Managed by Maven:

References and useful links

Sugar Removal Utility

Glycosylation statistics of COCONUT publication (Using the SRU)

Chemistry Development Kit (CDK)

COlleCtion of Open NatUral producTs (COCONUT)