Metadata-Version: 1.2
Name: xfcs
Version: 1.1.6
Summary: Extract Flow Cytometry data from FCS files version 3+.
Home-page: https://github.com/j4c0bs/xfcs
Author: Jeremy Jacobs
Author-email: pub@j4c0bs.net
License: BSD
Description: xfcs
        =======
        Extract metadata and data from FCS (3.0, 3.1) files.
        
        Data extraction supports file formats:
            - Mode: List (L)
            - Datatypes: I, F, D
        
        Implemented parameter data set options:
            - raw
            - channel values
            - scale values (log10, gain)
            - channel and scale combined into one data set
            - fluorescence compensation
            - log10 scaled fluorescence compensation
        
        Metadata extraction features:
            - support for non-compliant files
            - merge or separate csv files
            - rolling mean for any keyword with a numeric value
            - append new fcs files to previously generated metadata csv file
        
        
        Interactive dashboard plots using the `xfcsdashboard <https://github.com/j4c0bs/xfcsdashboard>`_ add-on module.
          .. image:: docs/dashboard_preview.png
        
        
        Installation
        ------------
        
        Using pip:
        
        ::
        
            pip install xfcs
        
        Without pip:
        
        ::
        
            python setup.py install
        
        Command Line Usage
        ------------------
        
        See
        `USAGE <https://github.com/j4c0bs/xfcs/blob/master/docs/usage.md>`_
        for expanded details.
        
        To see a list of available commands and arguments, run ''xfcs data --help'' or ''xfcs metadata --help''
        
        ::
        
            extract data: xfcs data [options]
            extract metadata: xfcs metadata [options]
        
        Requirements
        ------------
        
        - Python 3.5 or greater
        - numpy
        - pandas
        
        License
        -------
        
        xfcs is released under the BSD 2-clause license. See
        `LICENSE <https://raw.githubusercontent.com/j4c0bs/xfcs/master/LICENSE.txt>`_
        for details.
        
Keywords: FCS FCS3.0 FCS3.1 flow cytometry
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Utilities
Requires-Python: >3.5
