Giter VIP home page Giter VIP logo

biotech-js's Introduction

biotech-js

Documentation

Package initially developed at and for A&A Biotechnology for reading all kinds of biotechnology related files.

Currently it supports fastq, fasta and genbank files.

Usage

Reading Fasta file

import { FastaSequenceFile, ProcessingStatus } from "biotech-js";

const file = new FastaSequenceFile("path/to/file.fa");
await file.process();

expect(file.processingStatus).toBe(ProcessingStatus.SuccessFinished);
expect(file.sequences.length).toBe(12345);
expect(file.tookMs).toBeLessThan(1000);

await file.save();
// Default output path is "path/to/file_processed.fa"
// But you can customize it by passing a path to the save method
await file.save("path/to/file2.fa");

Reading Fastq file

import { FastqSequenceFile, ProcessingStatus } from "biotech-js";

const file = new FastqSequenceFile("path/to/file1.fastq");
await file.process();

expect(file.processingStatus).toBe(ProcessingStatus.SuccessFinished);
expect(file.sequences.length).toBe(12345);
expect(file.tookMs).toBeLessThan(1000);

await file.save("path/to/file2.fastq");

Reading Genbank file

import { GenbankSequencesFile, ProcessingStatus } from "biotech-js";

const file = new GenbankSequencesFile("path/to/file1.gb");
await file.process();

expect(file.processingStatus).toBe(ProcessingStatus.SuccessFinished);
expect(file.sequences.length).toBe(12345);
expect(file.tookMs).toBeLessThan(1000);

await file.save("path/to/file2.gb");

Detecting file extension

import { FileExtensionHandler } from "biotech-js";

const path = "path/to/file.fa";
const pathExtension = path.split(".").pop();

const extension = FileExtensionHandler.fileExtensionToEnum(pathExtension);
console.log(extension);
// Output: Fasta

Deployment

When deploying the library to npm run:

yarn b

biotech-js's People

Contributors

tomek7667 avatar

Watchers

 avatar

biotech-js's Issues

[BUG] Empty sequences present

image
const file = new GenbankSequencesFile(path);
await file.process();
console.log(
	`took ms: ${file.processingStatus}, loaded ${file.sequencesNumber} sequences`
);
console.log(file.sequences.filter((s) => s.Source === undefined));

data loaded from here.
Dataset


File NUC_PT.zip contains genbank file which is not loaded fully. The sequences should contain some additional checks after processing

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.