Seqanswers Leaderboard Ad

Collapse

Announcement

Collapse
No announcement yet.
X
 
  • Filter
  • Time
  • Show
Clear All
new posts

  • Illuminate: processor for Illumina InterOP Run binaries (in Python)

    Greetings all,

    I work at InVitae and we just publicly released a library called Illuminate.



    The purpose of Illuminate is to emulate the stats you see when you load a run data folder within Illumina SAV, providing programmatic access to these metrics for whatever purposes you may have -- data storage, analysis, automated machine monitoring, and so on.

    This is completely free, open source software (MIT License) written in Python with the intent to be used, tested, and improved upon by the bioinformatics community.

    Features:
    • Simple command-line tool you can use to quickly inspect a run.
    • Built to be easily integrated into other code.
    • Easily extensible even if you think you are "not much of a programmer".
    • Results standardized to pandas DataFrame objects (so if you know how to work in R, you can probably get up to speed quickly with this)


    Here's an example of the smallest python script you could get away with using this tool.

    Code:
    import illuminate
    myDataset = illuminate.InteropDataset('path/to/rundata/')
    print myDataset.meta
    print myDataset.IndexMetrics()
    print myDataset.TileMetrics()
    print myDataset.QualityMetrics()
    And here's an example of how you would use the command-line reporter to do the same thing:

    Code:
    python illuminate --meta --index --tile --quality /path/to/rundata
    You can even have illuminate open up in an interactive iPython shell, where the dataset will be loaded up into an InteropDataset object for you:

    Code:
    python illuminate -i /path/to/rundata
    Not all of the metrics objects are fully fleshed out yet, although all of the binary parsers are "feature complete" in that you can produce a data dictionary and a DataFrame from them.

    I'm hoping that some of you fine folks can pipe up and let me know what might be useful to you -- or better, submit contributions, bug reports, and so on that will help Illuminate become as full-featured as it needs to be.

    This library has been in our production pipeline for several months now, reporting on cluster density, quality, and yield so we can keep tabs on sequencing run quality in an automated fashion.

    If you use it, or you have questions about it, please comment here and let me know!

    Cheers,
    Naomi

  • #2
    interesting, never thought of cracking the bin files.. thanks.

    Comment


    • #3
      Now available through pypi (pip)

      I just pushed the latest stable version of Illuminate to the public pypi server, so you can install it via:
      • pip install illuminate


      Note that, due to weirdness in python packaging, you will probably have to install two of its dependencies manually:
      • pip install numpy
      • pip install pandas


      More detailed instructions can be found on the pypi.python.org page for Illuminate.

      Stable versions will always be found there; development versions will always come from the bitbucket repository (see original post in this thread).

      Cheers,
      Naomi

      Comment

      Latest Articles

      Collapse

      • seqadmin
        Advancing Precision Medicine for Rare Diseases in Children
        by seqadmin




        Many organizations study rare diseases, but few have a mission as impactful as Rady Children’s Institute for Genomic Medicine (RCIGM). “We are all about changing outcomes for children,” explained Dr. Stephen Kingsmore, President and CEO of the group. The institute’s initial goal was to provide rapid diagnoses for critically ill children and shorten their diagnostic odyssey, a term used to describe the long and arduous process it takes patients to obtain an accurate...
        12-16-2024, 07:57 AM
      • seqadmin
        Recent Advances in Sequencing Technologies
        by seqadmin



        Innovations in next-generation sequencing technologies and techniques are driving more precise and comprehensive exploration of complex biological systems. Current advancements include improved accessibility for long-read sequencing and significant progress in single-cell and 3D genomics. This article explores some of the most impactful developments in the field over the past year.

        Long-Read Sequencing
        Long-read sequencing has seen remarkable advancements,...
        12-02-2024, 01:49 PM

      ad_right_rmr

      Collapse

      News

      Collapse

      Topics Statistics Last Post
      Started by seqadmin, 12-17-2024, 10:28 AM
      0 responses
      32 views
      0 likes
      Last Post seqadmin  
      Started by seqadmin, 12-13-2024, 08:24 AM
      0 responses
      47 views
      0 likes
      Last Post seqadmin  
      Started by seqadmin, 12-12-2024, 07:41 AM
      0 responses
      34 views
      0 likes
      Last Post seqadmin  
      Started by seqadmin, 12-11-2024, 07:45 AM
      0 responses
      45 views
      0 likes
      Last Post seqadmin  
      Working...
      X