Coder Social home page Coder Social logo

lpatiny / jcampconverter Goto Github PK

View Code? Open in Web Editor NEW

This project forked from andcastillo/jcampconverter

0.0 1.0 0.0 54.33 MB

Convert JCAMP data to javascript objects

Home Page: http://cheminfo.github.io/jcampconverter/

License: MIT License

JavaScript 97.68% HTML 2.32%

jcampconverter's Introduction

JCAMP converter

Parse and convert JCAMP data

Zakodium logo

Maintained by Zakodium

NPM version build status Test coverage npm download DOI

Installation

Node JS

npm install jcampconverter

Bower

bower install jcampconverter

Methods

convert(jcamp, [options])

Converts the jcamp using options.
Returns an object with information about the converted file and uncompressed spectra data.

Arguments

  • jcamp - String or ArrayBuffer containing the JCAMP data
  • options - Object with options to pass to the converter

Options

  • keepRecordsRegExp - regexp to select which records should be placed in the info field. By default: :/^$/} (nothing is kept)
  • withoutXY - do not parse XYDATA or PEAKTABLE fields. Useful to only extract metadata fields (combine this option with keepRecordsRegExp)
  • chromatogram - use the new GC/MS data format output (default: false)
  • canonicDataLabels - canonize data labels (uppercase) (default: true).
  • canonicMetadataLabels - canonize data labels (uppercase) (default: false).
  • dynamicTyping - When parsing field convert to number if a number (default: true)

2D NMR options:

  • noContour - if true, the contour levels will not be generated. Instead the raw data will be available in result.minMax.z (default: false)
  • nbContourLevels - number of contour levels to use in each positive and negative sides (default: 7)
  • noiseMultiplier - default: 5
  • keepSpectra - Generate array for 2D NMR spectra (default: false)

Use as a module

Node.JS

var converter = require('jcampconverter');
var jcamp = require('fs').readFileSync('path/to/jcamp.dx', 'utf8');

var result = converter.convert(jcamp);

// if there is only one spectrum it will be in
console.log(result.flatten[0]);

// the converter will also keep the full jcamp tree

Testing and build

npm install
npm test
npm run build

Benchmark

npm run benchmark

License

MIT

jcampconverter's People

Contributors

andcastillo avatar cheminfo-bot avatar jasonychuang avatar jeffersonh44 avatar lpatiny avatar maasencioh avatar npellet avatar sebastien-ahkrin avatar targos avatar

Watchers

 avatar

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.