Skip to content

Commit

Permalink
update docs with more module details
Browse files Browse the repository at this point in the history
  • Loading branch information
whitews committed Feb 12, 2021
1 parent 1045958 commit 1b4b872
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 4 deletions.
21 changes: 19 additions & 2 deletions docs/api.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,35 @@
FlowUtils API
===================================

FlowUtils includes 2 modules: :code:`compensate` and :code:`transforms`
containing functions for compensation and various transforms, respectively.

compensate Module
-----------------

The :code:`compensate` module includes functions for parsing the spillover
keyword value from the metadata within an FCS file, creating a compensation
from CSV or NumPy input types, and for applying a compensation matrix to
FCS event data (as a NumPy array).

.. toctree::
:maxdepth: 2

compensate
compensate functions <compensate>

transforms Module
-----------------

The :code:`transforms` module includes functions for applying various
transformations (and their inverse) to FCS event data that are commonly used within the
flow cytometry community. These include:

- Logarithmic
- Inverse hyperbolic sine (asinh)
- Logicle
- Hyperlog

.. toctree::
:maxdepth: 2

transforms
transforms functions <transforms>
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ cytometry data, and was developed as an extension to the light-weight
[FlowIO library](https://github.com/whitews/FlowIO). FlowIO reads and
writes Flow Cytometry Standard (FCS) files, and has zero dependencies.
For higher level interaction with flow cytometry data, including
GatingML support, see the related
GatingML & FlowJo 10 support, see the related
[FlowKit project](https://github.com/whitews/FlowKit).

Installation
Expand Down Expand Up @@ -62,6 +62,6 @@ API
* :ref:`genindex`

.. toctree::
:maxdepth: 2
:maxdepth: 3

api

0 comments on commit 1b4b872

Please sign in to comment.