flowio

A Python library for reading and writing Flow Cytometry Standard (FCS) files

https://github.com/whitews/flowio

Science Score: 46.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    1 of 10 committers (10.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.0%) to scientific vocabulary

Keywords

cytometry fcs fcs-files flow-cytometry flow-cytometry-analysis flow-cytometry-files immunology python
Last synced: 6 months ago · JSON representation

Repository

A Python library for reading and writing Flow Cytometry Standard (FCS) files

Basic Info
  • Host: GitHub
  • Owner: whitews
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: master
  • Homepage: https://flowio.readthedocs.io
  • Size: 11.5 MB
Statistics
  • Stars: 46
  • Watchers: 4
  • Forks: 23
  • Open Issues: 2
  • Releases: 18
Topics
cytometry fcs fcs-files flow-cytometry flow-cytometry-analysis flow-cytometry-files immunology python
Created about 12 years ago · Last pushed 10 months ago
Metadata Files
Readme License

README.md

FlowIO

PyPI license PyPI pyversions PyPI version DOI

Test (master) Test (develop) Coverage Documentation Status PyPI - Downloads

Overview

FlowIO is a Python library for reading and writing Flow Cytometry Standard (FCS) files, with minimal dependencies and is compatible with Python 3.9+. It is intended as a lightweight library, suitable for parsing FCS data sets (e.g. as a web server backend, for simple metadata extraction, etc.). For higher level cytometry analysis, please see the related FlowKit library which offers a much wider set of analysis options such as compensation, transformation, and gating support (including support for importing FlowJo 10 workspaces).

If you have any questions about FlowIO, find any bugs, or feel something is missing from the documentation please submit an issue to the GitHub repository here.

Installation

The recommended way to install FlowIO is via the pip command:

pip install flowio

Or, if you prefer, you can install from the GitHub source:

git clone https://github.com/whitews/flowio cd flowio pip install .

Documentation

The FlowIO API documentation is available on ReadTheDocs here. If you have any questions about FlowIO or find any bugs please submit an issue to the GitHub repository here.

Changelogs

Changelogs for versions are available here

Owner

  • Name: Scott White
  • Login: whitews
  • Kind: user
  • Location: Durham, NC

GitHub Events

Total
  • Create event: 1
  • Release event: 1
  • Issues event: 2
  • Watch event: 6
  • Issue comment event: 8
  • Push event: 29
  • Pull request event: 6
  • Fork event: 5
Last Year
  • Create event: 1
  • Release event: 1
  • Issues event: 2
  • Watch event: 6
  • Issue comment event: 8
  • Push event: 29
  • Pull request event: 6
  • Fork event: 5

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 342
  • Total Committers: 10
  • Avg Commits per committer: 34.2
  • Development Distribution Score (DDS): 0.073
Past Year
  • Commits: 68
  • Committers: 3
  • Avg Commits per committer: 22.667
  • Development Distribution Score (DDS): 0.029
Top Committers
Name Email Commits
whitews w****s@g****m 317
Maxmilian Bertsch m****h@g****e 7
Zach Bjornson z****n@g****m 5
Matt Faria m****p@g****m 4
Tristan Ranff 4****f 2
Lewis Grozinger l****2@n****k 2
Andreas Wilm a****m@i****m 2
Louis l****l@l****t 1
Konstantin Ivanov 6****a 1
Christian Rickert r****n@i****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 17
  • Total pull requests: 20
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 26 days
  • Total issue authors: 14
  • Total pull request authors: 11
  • Average comments per issue: 2.71
  • Average comments per pull request: 2.2
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 6
  • Average time to close issues: N/A
  • Average time to close pull requests: 20 days
  • Issue authors: 2
  • Pull request authors: 3
  • Average comments per issue: 0.5
  • Average comments per pull request: 2.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • whitews (2)
  • lgrozinger (2)
  • JcGKitten (2)
  • matt-faria (1)
  • BastienDussap (1)
  • jfgonsalves (1)
  • andreas-wilm (1)
  • asmvernon (1)
  • niloofar78 (1)
  • sjkdenny (1)
  • berombau (1)
  • cchrysosdtx (1)
  • davidpng (1)
  • mpschr (1)
Pull Request Authors
  • zbjornson (5)
  • JcGKitten (3)
  • matt-faria (2)
  • christianrickert (2)
  • Zethson (2)
  • ikonsta (2)
  • tristan-ranff (1)
  • andreas-wilm (1)
  • lgrozinger (1)
  • whitews (1)
  • Louis-Pujol (1)
Top Labels
Issue Labels
bug (3) enhancement (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 9,926 last-month
  • Total dependent packages: 4
  • Total dependent repositories: 6
  • Total versions: 23
  • Total maintainers: 1
pypi.org: flowio

FlowIO is a Python library for reading / writing Flow Cytometry Standard (FCS) files

  • Homepage: https://github.com/whitews/flowio
  • Documentation: https://flowio.readthedocs.io/en/latest/
  • License: BSD 3-Clause License Copyright (c) 2019, Scott White All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  • Latest release: 1.4.0
    published 10 months ago
  • Versions: 23
  • Dependent Packages: 4
  • Dependent Repositories: 6
  • Downloads: 9,926 Last month
Rankings
Dependent packages count: 2.4%
Dependent repos count: 6.0%
Downloads: 6.0%
Average: 7.2%
Forks count: 10.2%
Stargazers count: 11.2%
Maintainers (1)
Last synced: 6 months ago

Dependencies

requirements_test.txt pypi
  • numpy * test
.github/workflows/tests_develop.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • codecov/codecov-action v2 composite
.github/workflows/tests_master.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • codecov/codecov-action v2 composite
.github/workflows/test_flowkit_develop.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/test_flowkit_master.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite