README.md

TopDown SDK

The TopDown Software Development Kit (SDK) is the Consortium for Top-Down Proteomics' open-source software solution for common top-down proteomics tasks.

Nuget Installation

Install topdown-sdk from nuget.

Usage

Basic syntax parsing

var parser = new ProFormaParser();
var term = parser.ParseString("PRQ[info:test]TEOFORM");

Term validation and coverting to a proteoform group.

// Initialize providers and modification lookup
var elementProvider = new ElementProvider();
var residueProvider = new IupacAminoAcidProvider(elementProvider);

// Pull in all RESID modifications
var residParser = new ResidXmlParser();
var modifications = parser.Parse("path to RESID XML");
var residLookup = ResidModificationLookup.CreateFromModifications(modifications, elementProvider);

// Create a simple term in code as an example
// SEQV[RESID:AA0038]ENCE
var term = new ProFormaTerm("SEQVENCE", null, null, new List<ProFormaTag>
{
    new ProFormaTag(3, new[] { new ProFormaDescriptor(ProFormaKey.Identifier, ProFormaEvidenceType.Resid, "RESID:AA0420") })
});

// Validate and create proteoform group
var factory = new ProteoformGroupFactory(elementProvider, residueProvider);
var proteoform = factory.CreateProteoformGroup(term, residLookup);

Credits

We would like to thank the Consortium and its members for their continued support.