-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update docs with more module details
- Loading branch information
Showing
2 changed files
with
21 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters