datanuggets-flow 0.1.0a3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (80) hide show
  1. datanuggets_flow-0.1.0a3/.gitignore +36 -0
  2. datanuggets_flow-0.1.0a3/LICENSE +338 -0
  3. datanuggets_flow-0.1.0a3/PKG-INFO +233 -0
  4. datanuggets_flow-0.1.0a3/README.md +198 -0
  5. datanuggets_flow-0.1.0a3/THIRD_PARTY.md +104 -0
  6. datanuggets_flow-0.1.0a3/docs/README.md +17 -0
  7. datanuggets_flow-0.1.0a3/docs/api.md +658 -0
  8. datanuggets_flow-0.1.0a3/docs/cli.md +456 -0
  9. datanuggets_flow-0.1.0a3/docs/limitations.md +51 -0
  10. datanuggets_flow-0.1.0a3/docs/methodology.md +249 -0
  11. datanuggets_flow-0.1.0a3/docs/quickstart.md +81 -0
  12. datanuggets_flow-0.1.0a3/docs/releases.md +18 -0
  13. datanuggets_flow-0.1.0a3/docs/reproducibility.md +181 -0
  14. datanuggets_flow-0.1.0a3/pyproject.toml +100 -0
  15. datanuggets_flow-0.1.0a3/src/datanuggets_flow/__init__.py +32 -0
  16. datanuggets_flow-0.1.0a3/src/datanuggets_flow/_defaults.py +120 -0
  17. datanuggets_flow-0.1.0a3/src/datanuggets_flow/_pick/__init__.py +3 -0
  18. datanuggets_flow-0.1.0a3/src/datanuggets_flow/_pick/args.py +351 -0
  19. datanuggets_flow-0.1.0a3/src/datanuggets_flow/_pick/prompt.py +78 -0
  20. datanuggets_flow-0.1.0a3/src/datanuggets_flow/_pipeline/__init__.py +2 -0
  21. datanuggets_flow-0.1.0a3/src/datanuggets_flow/_pipeline/clustering.py +397 -0
  22. datanuggets_flow-0.1.0a3/src/datanuggets_flow/_pipeline/cofactor.py +113 -0
  23. datanuggets_flow-0.1.0a3/src/datanuggets_flow/_pipeline/fcs.py +93 -0
  24. datanuggets_flow-0.1.0a3/src/datanuggets_flow/_pipeline/gating.py +102 -0
  25. datanuggets_flow-0.1.0a3/src/datanuggets_flow/_pipeline/records.py +232 -0
  26. datanuggets_flow-0.1.0a3/src/datanuggets_flow/_pipeline/selection.py +89 -0
  27. datanuggets_flow-0.1.0a3/src/datanuggets_flow/_pipeline/stages.py +260 -0
  28. datanuggets_flow-0.1.0a3/src/datanuggets_flow/_pipeline/tables.py +101 -0
  29. datanuggets_flow-0.1.0a3/src/datanuggets_flow/_validate.py +33 -0
  30. datanuggets_flow-0.1.0a3/src/datanuggets_flow/colors.py +22 -0
  31. datanuggets_flow-0.1.0a3/src/datanuggets_flow/compare.py +183 -0
  32. datanuggets_flow-0.1.0a3/src/datanuggets_flow/exceptions.py +22 -0
  33. datanuggets_flow-0.1.0a3/src/datanuggets_flow/figures.py +166 -0
  34. datanuggets_flow-0.1.0a3/src/datanuggets_flow/gate.py +173 -0
  35. datanuggets_flow-0.1.0a3/src/datanuggets_flow/grid.py +75 -0
  36. datanuggets_flow-0.1.0a3/src/datanuggets_flow/livecells.py +432 -0
  37. datanuggets_flow-0.1.0a3/src/datanuggets_flow/outputs.py +212 -0
  38. datanuggets_flow-0.1.0a3/src/datanuggets_flow/peaks.py +84 -0
  39. datanuggets_flow-0.1.0a3/src/datanuggets_flow/pick.py +296 -0
  40. datanuggets_flow-0.1.0a3/src/datanuggets_flow/pipeline.py +55 -0
  41. datanuggets_flow-0.1.0a3/src/datanuggets_flow/plot.py +137 -0
  42. datanuggets_flow-0.1.0a3/src/datanuggets_flow/settings.py +323 -0
  43. datanuggets_flow-0.1.0a3/src/datanuggets_flow/state.py +429 -0
  44. datanuggets_flow-0.1.0a3/tests/conftest.py +8 -0
  45. datanuggets_flow-0.1.0a3/tests/exactcsv.py +24 -0
  46. datanuggets_flow-0.1.0a3/tests/fixtures/flow/154.npz +0 -0
  47. datanuggets_flow-0.1.0a3/tests/fixtures/flow/202.npz +0 -0
  48. datanuggets_flow-0.1.0a3/tests/fixtures/flow/202_fluor.npz +0 -0
  49. datanuggets_flow-0.1.0a3/tests/fixtures/flow/223.npz +0 -0
  50. datanuggets_flow-0.1.0a3/tests/fixtures/flow/README.md +37 -0
  51. datanuggets_flow-0.1.0a3/tests/flow/conftest.py +13 -0
  52. datanuggets_flow-0.1.0a3/tests/flow/library_uses.py +37 -0
  53. datanuggets_flow-0.1.0a3/tests/flow/test_flow_area.py +67 -0
  54. datanuggets_flow-0.1.0a3/tests/flow/test_flow_boundary.py +167 -0
  55. datanuggets_flow-0.1.0a3/tests/flow/test_flow_cofactor.py +777 -0
  56. datanuggets_flow-0.1.0a3/tests/flow/test_flow_cofactor_rule.py +154 -0
  57. datanuggets_flow-0.1.0a3/tests/flow/test_flow_colors.py +203 -0
  58. datanuggets_flow-0.1.0a3/tests/flow/test_flow_fcs_integration.py +192 -0
  59. datanuggets_flow-0.1.0a3/tests/flow/test_flow_gate.py +211 -0
  60. datanuggets_flow-0.1.0a3/tests/flow/test_flow_grid.py +78 -0
  61. datanuggets_flow-0.1.0a3/tests/flow/test_flow_import.py +47 -0
  62. datanuggets_flow-0.1.0a3/tests/flow/test_flow_library_pins.py +91 -0
  63. datanuggets_flow-0.1.0a3/tests/flow/test_flow_livecells.py +462 -0
  64. datanuggets_flow-0.1.0a3/tests/flow/test_flow_outputs.py +509 -0
  65. datanuggets_flow-0.1.0a3/tests/flow/test_flow_peaks.py +66 -0
  66. datanuggets_flow-0.1.0a3/tests/flow/test_flow_pick.py +654 -0
  67. datanuggets_flow-0.1.0a3/tests/flow/test_flow_pipeline.py +644 -0
  68. datanuggets_flow-0.1.0a3/tests/flow/test_flow_scale.py +486 -0
  69. datanuggets_flow-0.1.0a3/tests/flow/test_flow_settings.py +351 -0
  70. datanuggets_flow-0.1.0a3/tests/flow/test_flow_stages.py +518 -0
  71. datanuggets_flow-0.1.0a3/tests/flow/test_flow_state.py +315 -0
  72. datanuggets_flow-0.1.0a3/tests/flow/test_flow_tsne.py +33 -0
  73. datanuggets_flow-0.1.0a3/tests/flow/test_flow_validate.py +51 -0
  74. datanuggets_flow-0.1.0a3/tests/flowcases.py +241 -0
  75. datanuggets_flow-0.1.0a3/tests/plot/conftest.py +19 -0
  76. datanuggets_flow-0.1.0a3/tests/plot/test_plot_flow.py +168 -0
  77. datanuggets_flow-0.1.0a3/tests/test_import_graph.py +174 -0
  78. datanuggets_flow-0.1.0a3/tests/test_lock_sources.py +26 -0
  79. datanuggets_flow-0.1.0a3/tests/test_public_paths.py +189 -0
  80. datanuggets_flow-0.1.0a3/tests/test_version.py +29 -0
@@ -0,0 +1,36 @@
1
+ .venv/
2
+ __pycache__/
3
+ *.egg-info/
4
+ .pytest_cache/
5
+ .ruff_cache/
6
+ dist/
7
+ build/
8
+ tmp/
9
+ outputs/
10
+
11
+ # Local planning and review notes
12
+ /docs/specs/
13
+ /docs/plans/
14
+ /docs/reviews/
15
+
16
+ # Local R reference tooling; recorded test fixtures stay tracked
17
+ /r/
18
+ *.[Rr]
19
+ /.github/workflows/bench.yml
20
+
21
+ # App demo data fetched by app/scripts/fetch_demos.py (sha256-pinned in app/demo/manifest.json);
22
+ # it is all fetched, none committed. Large sets land in tmp/demo-large/ (fetch_demo_large.py).
23
+ /app/demo/data/*.fcs
24
+ /app/demo/data/*.part
25
+
26
+ # Local secrets and keys
27
+ .env
28
+ .env.*
29
+ secrets/
30
+ *.pem
31
+ *.key
32
+ *.tfvars
33
+ id_rsa*
34
+ id_ed25519*
35
+ credentials.json
36
+ telegram.json
@@ -0,0 +1,338 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5
+ <https://fsf.org/>
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Lesser General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
281
+
282
+ How to Apply These Terms to Your New Programs
283
+
284
+ If you develop a new program, and you want it to be of the greatest
285
+ possible use to the public, the best way to achieve this is to make it
286
+ free software which everyone can redistribute and change under these terms.
287
+
288
+ To do so, attach the following notices to the program. It is safest
289
+ to attach them to the start of each source file to most effectively
290
+ convey the exclusion of warranty; and each file should have at least
291
+ the "copyright" line and a pointer to where the full notice is found.
292
+
293
+ <one line to give the program's name and a brief idea of what it does.>
294
+ Copyright (C) <year> <name of author>
295
+
296
+ This program is free software; you can redistribute it and/or modify
297
+ it under the terms of the GNU General Public License as published by
298
+ the Free Software Foundation; either version 2 of the License, or
299
+ (at your option) any later version.
300
+
301
+ This program is distributed in the hope that it will be useful,
302
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
303
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304
+ GNU General Public License for more details.
305
+
306
+ You should have received a copy of the GNU General Public License along
307
+ with this program; if not, see <https://www.gnu.org/licenses/>.
308
+
309
+ Also add information on how to contact you by electronic and paper mail.
310
+
311
+ If the program is interactive, make it output a short notice like this
312
+ when it starts in an interactive mode:
313
+
314
+ Gnomovision version 69, Copyright (C) year name of author
315
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
316
+ This is free software, and you are welcome to redistribute it
317
+ under certain conditions; type `show c' for details.
318
+
319
+ The hypothetical commands `show w' and `show c' should show the appropriate
320
+ parts of the General Public License. Of course, the commands you use may
321
+ be called something other than `show w' and `show c'; they could even be
322
+ mouse-clicks or menu items--whatever suits your program.
323
+
324
+ You should also get your employer (if you work as a programmer) or your
325
+ school, if any, to sign a "copyright disclaimer" for the program, if
326
+ necessary. Here is a sample; alter the names:
327
+
328
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
329
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
330
+
331
+ <signature of Moe Ghoul>, 1 April 1989
332
+ Moe Ghoul, President of Vice
333
+
334
+ This General Public License does not permit incorporating your program into
335
+ proprietary programs. If your program is a subroutine library, you may
336
+ consider it more useful to permit linking proprietary applications with the
337
+ library. If this is what you want to do, use the GNU Lesser General
338
+ Public License instead of this License.
@@ -0,0 +1,233 @@
1
+ Metadata-Version: 2.5
2
+ Name: datanuggets-flow
3
+ Version: 0.1.0a3
4
+ Summary: Clusters flow cytometry events across FCS files with data nuggets.
5
+ Project-URL: Source, https://github.com/ron2k1/datanuggetsflowcytometry
6
+ Project-URL: Documentation, https://github.com/ron2k1/datanuggetsflowcytometry/blob/main/docs/README.md
7
+ Project-URL: Issues, https://github.com/ron2k1/datanuggetsflowcytometry/issues
8
+ Author: Ronil Basu
9
+ License-Expression: GPL-2.0-only AND CC-BY-4.0
10
+ License-File: LICENSE
11
+ License-File: THIRD_PARTY.md
12
+ Keywords: FCS,data nuggets,flow cytometry,gating,weighted clustering
13
+ Classifier: Development Status :: 3 - Alpha
14
+ Classifier: Intended Audience :: Science/Research
15
+ Classifier: Operating System :: MacOS
16
+ Classifier: Operating System :: Microsoft :: Windows
17
+ Classifier: Operating System :: POSIX :: Linux
18
+ Classifier: Programming Language :: Python :: 3
19
+ Classifier: Programming Language :: Python :: 3 :: Only
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Classifier: Programming Language :: Python :: 3.13
22
+ Classifier: Programming Language :: Python :: 3.14
23
+ Classifier: Programming Language :: Python :: 3.15
24
+ Classifier: Topic :: Scientific/Engineering :: Information Analysis
25
+ Classifier: Topic :: Scientific/Engineering :: Mathematics
26
+ Requires-Python: >=3.12
27
+ Requires-Dist: datanuggets<0.2,>=0.1.0a3
28
+ Requires-Dist: flowio<1.5,>=1.4
29
+ Requires-Dist: matplotlib>=3.9
30
+ Requires-Dist: numpy>=2.0
31
+ Requires-Dist: pandas>=2.2
32
+ Requires-Dist: scikit-learn>=1.5
33
+ Requires-Dist: scipy>=1.13
34
+ Description-Content-Type: text/markdown
35
+
36
+ # datanuggets-flow
37
+
38
+ Explore flow cytometry populations across multiple FCS files with data nuggets.
39
+
40
+ ![The plot view of the datanuggets-flow app, with a t-SNE of data nuggets colored by cluster](https://github.com/ron2k1/datanuggetsflowcytometry/raw/main/docs/images/app-tsne.png)
41
+
42
+ The app's plot view shows a t-SNE of the data nuggets from four public PBMC demonstration files. Each point is sized by its nugget weight and colored by its cluster.
43
+
44
+ A flow cytometry experiment can produce millions of events across dozens of samples. Analyzing each file separately makes it hard to compare clusters across samples. Analyzing everything together can become expensive, especially when a method needs pairwise distances.
45
+
46
+ `datanuggets-flow` takes a middle route. It helps you select candidate populations in each file using forward and side scatter, reduces the selected events to weighted data nuggets and clusters the pooled nuggets in one analysis. The cluster labels are shared across the files in a run, so you can examine how their relative abundance and marker profiles differ between samples.
47
+
48
+ The package builds on [`datanuggets`](https://pypi.org/project/datanuggets/), a Python port of the R packages `datanugget` and `WCluster`. It offers a local web app, a command-line interface and a Python API.
49
+
50
+ > **Research alpha (`0.1.0a3`).** This is an exploratory analysis tool. It isn't an automated cell-type identification system or a validated clinical analysis system. Its clusters are mathematical groupings, and they aren't confirmed biological populations. The API and analysis defaults may change.
51
+
52
+ [App guide](https://github.com/ron2k1/datanuggetsflowcytometry/blob/main/docs/app/running-locally.md) · [Command reference](https://github.com/ron2k1/datanuggetsflowcytometry/blob/main/docs/cli.md) · [Python API](https://github.com/ron2k1/datanuggetsflowcytometry/blob/main/docs/api.md) · [Methodology](https://github.com/ron2k1/datanuggetsflowcytometry/blob/main/docs/methodology.md) · [Limitations](https://github.com/ron2k1/datanuggetsflowcytometry/blob/main/docs/limitations.md)
53
+
54
+ ## Get started
55
+
56
+ ### Use the local app
57
+
58
+ With Docker installed, run:
59
+
60
+ ```sh
61
+ docker run --rm -p 127.0.0.1:8000:8000 -v datanuggets-data:/data ghcr.io/ron2k1/datanuggets-flow:0.1.0a3
62
+ ```
63
+
64
+ Open <http://127.0.0.1:8000> in your browser. The app lets you inspect candidate gates, choose which populations to include, run the clustering and explore the results with interactive plots.
65
+
66
+ The address is bound to your own computer rather than your local network. The named Docker volume keeps uploads and completed runs between containers. The analysis runs on your computer. Downloading the container image itself requires a network connection. Check your environment's network and data-handling requirements before you use sensitive files.
67
+
68
+ The image includes a small public PBMC demonstration dataset of four FCS files, so you can explore the workflow before adding your own. The [app guide](https://github.com/ron2k1/datanuggetsflowcytometry/blob/main/docs/app/running-locally.md) covers the app's settings and building the image from source.
69
+
70
+ ![The population step of the app, with each file's scatter density and tick boxes for its candidate populations](https://github.com/ron2k1/datanuggetsflowcytometry/raw/main/docs/images/app-populations.png)
71
+
72
+ The population step shows each file's FSC-A and SSC-A density with the peaks the gate finder kept. You tick the populations to carry into the clustering.
73
+
74
+ ![The cluster step of the app, with the cluster count, the nuggets per file and a tick box for every channel](https://github.com/ron2k1/datanuggetsflowcytometry/raw/main/docs/images/app-cluster-settings.png)
75
+
76
+ The cluster step is where you set the number of clusters and how many nuggets each file keeps. You can also change the transform and the clustering method, and tick the marker channels to cluster on.
77
+
78
+ ### Install from PyPI
79
+
80
+ The package requires Python 3.12 or newer and a platform that the underlying `datanuggets` package supports. Those are Windows x64, Apple silicon Macs running macOS 12 or newer, and Linux x86-64 or ARM64 with glibc 2.27 or newer. Install the pinned alpha:
81
+
82
+ ```sh
83
+ python -m pip install "datanuggets-flow==0.1.0a3"
84
+ ```
85
+
86
+ The package uses `datanuggets` for reduction and weighted clustering, `flowio` for FCS input, and pandas, matplotlib and scikit-learn for analysis and reporting.
87
+
88
+ ### Run the command-line workflow
89
+
90
+ ```sh
91
+ datanuggets-flow path/to/fcs_folder
92
+ ```
93
+
94
+ The command finds candidate scatter populations in each FCS file, shows the gating figure and asks which populations to keep. It then runs a joint clustering analysis and writes the figures, tables and settings to a new output directory.
95
+
96
+ For a two-step workflow, use `--gates-only` to inspect the gates first and `--from-gates` to continue from saved gates. The [command reference](https://github.com/ron2k1/datanuggetsflowcytometry/blob/main/docs/cli.md) lists every option and output file.
97
+
98
+ ### Run it from Python
99
+
100
+ The Python API exposes the same two stages. The first creates and saves the candidate gates. The second analyzes the populations you select.
101
+
102
+ ```python
103
+ from pathlib import Path
104
+
105
+ from datanuggets_flow.pipeline import gate_stage, cluster_stage, parse_selection
106
+ from datanuggets_flow.settings import GateSettings, ClusterSettings
107
+ from datanuggets_flow.state import load_gates, write_run
108
+
109
+ files = sorted(Path("path/to/fcs_folder").glob("*.fcs"))
110
+ gates_dir = Path("outputs/gates-001")
111
+ run_dir = Path("outputs/run-001")
112
+
113
+ # Use new folders for every run, so one run's files never mix with another's.
114
+ gates_dir.mkdir(parents=True)
115
+ gate_stage(files, gates_dir, GateSettings())
116
+
117
+ # Examine outputs/gates-001/local_maxima.png before selecting populations.
118
+ gates = load_gates(gates_dir)
119
+ selected = parse_selection(
120
+ "1,2", # Example only: review the numbering in every file.
121
+ [len(sample["stats"]) for sample in gates.samples],
122
+ )
123
+
124
+ run_dir.mkdir(parents=True)
125
+ settings = ClusterSettings(k=12)
126
+ result = cluster_stage(gates.samples, selected, run_dir, settings)
127
+
128
+ # Save run.json, the record of the run's settings.
129
+ write_run(
130
+ run_dir, gates_dir, settings, selected,
131
+ result.channels, result.labels,
132
+ scaling=result.pool.scaling,
133
+ cofactor=result.cofactor,
134
+ pool=result.pool,
135
+ )
136
+ print(result.tables.summary)
137
+ ```
138
+
139
+ The candidate populations are numbered separately for each file. Population 1 in one file isn't necessarily the same biological population as population 1 in another. The selection shown above is only an example. Inspect each gate before selecting it, and choose a cluster count appropriate for your experiment rather than assuming `k=12` is correct.
140
+
141
+ ## What happens in an analysis?
142
+
143
+ The pipeline has two stages. The first decides which events to keep. The second clusters the selected events together.
144
+
145
+ 1. **Read the FCS files.** Event values are read using `flowio`. The pipeline doesn't apply fluorescence spillover compensation. A file whose spillover matrix differs from the identity gets a warning, and the run goes on.
146
+ 2. **Find candidate gates.** For each file, the gate finder works in the FSC-A/SSC-A plane after a square-root transformation. It uses a 100 by 100 density grid and local peaks to propose populations. These are candidates for review. They aren't verified lymphocyte, monocyte or other cell identities.
147
+ 3. **Choose populations.** You decide which gates to retain in each sample. A candidate gate may overlap another, and events can lie outside every candidate gate. An event in two retained gates is counted once. `selection.csv` records how many events each file keeps.
148
+ 4. **Transform and scale markers.** Retained channels are transformed with `arcsinh(x / c)` and standardized using pooled statistics, so values from the included files are mapped into a common feature space. By default the cofactor `c` is chosen per channel by a package heuristic. It doesn't come from the Data Nuggets paper.
149
+ 5. **Create nuggets per file.** By default, the package targets up to 1,000 nuggets from the retained events in each file. In this pipeline, the default nugget center is an original selected event rather than a within-nugget mean. Each nugget also carries a weight describing how many events it represents and a scale describing within-nugget variability. The pipeline doesn't run the nugget refinement step used in the published flow cytometry example.
150
+ 6. **Cluster once.** Nuggets from all files are combined. Weighted k-means is the default, and weighted Ward hierarchical clustering is an alternative. The nugget weights matter because a nugget representing hundreds of cells shouldn't count the same as one representing a single cell.
151
+ 7. **Map results back to events.** The cluster assigned to a nugget is carried back to the original events represented by that nugget. The result is one common cluster-label system for the analyzed files.
152
+ 8. **Explore and export.** The run produces per-file cluster counts and proportions, marker summaries, PCA scores and plots. Each proportion is a share of the events retained in that file. Check the denominator before comparing it with whole-file or conventional gated-population frequencies.
153
+
154
+ Pooled clustering gives every file the same labels. It doesn't prove that a label denotes the same cell type in every file. Differences in compensation, instrument settings, panels, batch effects or gating can change the placement of events in marker space.
155
+
156
+ The [methodology guide](https://github.com/ron2k1/datanuggetsflowcytometry/blob/main/docs/methodology.md) gives every rule and constant behind these steps.
157
+
158
+ ## Explore the results
159
+
160
+ The app gives you several ways to inspect a finished run:
161
+
162
+ - **2D and 3D scatter plots** of nuggets or sampled cells, colored by the common cluster labels
163
+ - **Marker and PCA axes** to examine where clusters sit in measured or derived feature space
164
+ - **t-SNE views** for exploring local groupings, with separate two- and three-dimensional fits
165
+ - **Parallel-coordinate plots** for checking marker patterns across clusters
166
+ - **Per-cluster box plots and per-file comparison tables** for reviewing marker levels and cluster frequencies
167
+
168
+ ![A 3D t-SNE of the nuggets in the app's dark theme, colored by cluster](https://github.com/ron2k1/datanuggetsflowcytometry/raw/main/docs/images/app-3d-tsne-dark.png)
169
+
170
+ This is the demonstration run as a 3D t-SNE, shown in the app's dark theme. You can rotate and pan the plot.
171
+
172
+ ![A 3D scatter plot of the nuggets on CD3, CD19 and CD14 axes, colored by cluster](https://github.com/ron2k1/datanuggetsflowcytometry/raw/main/docs/images/app-3d-markers.png)
173
+
174
+ Marker axes put measured channels on the plot. This view has CD3, CD19 and CD14, and each axis has a menu for choosing another channel.
175
+
176
+ Nugget points can be sized according to their weights. A marker axis shows that channel's transformed values, so you can read a cluster's level and spread on the marker from the axis. PCA reports variation along weighted linear components. t-SNE offers a different view of local neighborhoods, but its visual gaps and apparent cluster sizes shouldn't be treated as quantitative distances or population sizes.
177
+
178
+ ![The box plot view, with one cluster's marker levels beside the rest of the run and its cell counts per file](https://github.com/ron2k1/datanuggetsflowcytometry/raw/main/docs/images/app-box-plots.png)
179
+
180
+ The box plot view compares a cluster's marker levels with the rest of the run. It also shows how many of the cluster's cells come from each file.
181
+
182
+ ![The compare view, with each cluster's share of every sample as a heatmap, a stacked bar chart and a table](https://github.com/ron2k1/datanuggetsflowcytometry/raw/main/docs/images/app-compare-samples.png)
183
+
184
+ The compare view shows each cluster's share of every sample as a heatmap, a stacked bar chart and a table. Each share is a percentage of the events retained in that file.
185
+
186
+ For programmatic analysis, run outputs include cluster summaries and coordinate tables such as `pca_scores.csv`, `tsne.csv`, `tsne3d.csv` and `cells.csv`. The saved `run.json` records the settings used for the analysis.
187
+
188
+ ## Research background
189
+
190
+ The method behind the reduction is described by Beavers et al. (2025). Data nuggets replace a large set of observations with a smaller collection of centers, weights and scales. The aim is to reduce computation while keeping the broad structure of the data, including its edges, which a random sample can miss. The paper demonstrates weighted PCA and weighted k-means on a flow cytometry dataset with 1,048,575 events, first reduced to 2,000 nuggets and then refined to 3,135. These are results from the published study.
191
+
192
+ The flow cytometry context is developed further in Dastgiri et al. (2026), which combines data nuggets with differential projection pursuit to find where cell populations differ most between experimental conditions. That work addresses an important limitation of manual two-dimensional gating. This package doesn't implement differential projection pursuit. It uses scatter-based gate selection, pooled nugget clustering and descriptive comparisons across files. These are distinct workflows and shouldn't be treated as equivalent.
193
+
194
+ Duan, Cabrera and Emir (2025) also develop projection pursuit for large datasets using data nuggets. That method searches for informative low-dimensional projections, and it's different from the PCA and t-SNE views included here. Pooled per-marker standardization also isn't the same operation as the multivariate spherization used in projection pursuit work. Cherasia et al. (2023) study data nuggets for supervised regression, which is outside this package's current clustering workflow.
195
+
196
+ The FSC/SSC candidate gate finder was adapted from Python code supplied by Prof. Javier Cabrera. Its thresholds and the package's choices about cofactors, per-file nugget creation, pooled scaling and cluster reporting aren't established by the Data Nuggets papers. The [methodology guide](https://github.com/ron2k1/datanuggetsflowcytometry/blob/main/docs/methodology.md#relation-to-the-papers) documents them, and they still need independent testing.
197
+
198
+ ## Before interpreting a cluster
199
+
200
+ These checks matter more than a convincing-looking plot:
201
+
202
+ - **Review every gate.** Scatter-based gating may miss rare populations or include debris. It doesn't replace a complete experimental gating strategy, including singlet and viability checks where appropriate.
203
+ - **Handle compensation and unmixing upstream.** The package doesn't perform them. Fluorescence measurements from incompatible or incorrectly compensated files shouldn't be pooled without correction.
204
+ - **Confirm channel correspondence.** All files need compatible markers, channel identities and experimental measurement scales. Matching channel names isn't enough to establish biological equivalence.
205
+ - **Check overlap and denominators.** Candidate gates may overlap. An event in two retained gates is counted once, and each percentage is a share of the events retained in that file. Confirm that's the population you mean to compare. Different gate selections across files can themselves change the proportions you compare.
206
+ - **Run sensitivity analyses.** Compare different random seeds, nugget counts and cluster counts. A mathematical cluster can appear or disappear when these settings change.
207
+ - **Inspect marker profiles before naming cells.** Cluster IDs are arbitrary integers. Biological labels require marker interpretation, appropriate controls and, ideally, validation against expert analysis or independent samples.
208
+ - **Don't treat group comparisons as statistical tests.** Differences in cluster percentages are descriptive unless a separate inferential analysis accounts for participants, replicates and the experimental design.
209
+ - **Keep the preprocessing record.** Store the FCS files, gate selections, channel mappings, transformations, settings, package versions and the completed run folder together.
210
+
211
+ Weighted Ward clustering also requires memory quadratic in the pooled nugget count. A 10,000 by 10,000 float64 matrix alone takes approximately 800 MB, before other analysis allocations. The [limitations](https://github.com/ron2k1/datanuggetsflowcytometry/blob/main/docs/limitations.md) list the open problems.
212
+
213
+ ## Reproducibility and scope
214
+
215
+ The nugget and weighted k-means implementations come from `datanuggets`. By default, nugget creation and the k-means starts draw from R's random number stream through `RDraws`, from seed `291102`. Even with a fixed seed, record the package versions and platform when comparing results.
216
+
217
+ The R packages implement the underlying reduction and weighted methods. This flow cytometry workflow adds its own gate finder, transformations, per-file reduction, plotting and reporting. The `datanuggets` port is tested against output from the R packages. That covers the numerical methods only. The steps this package adds haven't been validated against expert gating or independent samples, which is why this release is labeled a research alpha.
218
+
219
+ ## Papers and acknowledgments
220
+
221
+ ### Core method
222
+
223
+ Beavers, T. E., Cheng, G., Duan, Y., Cabrera, J., Lubomirski, M., Amaratunga, D., and Teigler, J. E. (2025). Data Nuggets: A Method for Reducing Big Data While Preserving Data Structure. *Journal of Computational and Graphical Statistics*, 34(1), 330-342. Published online in 2024. [doi:10.1080/10618600.2024.2341896](https://doi.org/10.1080/10618600.2024.2341896).
224
+
225
+ ### Related research
226
+
227
+ - Dastgiri, M., Cabrera, J., Duan, Y., et al. (2026). Novel machine learning approach to differential cell flow cytometry analysis based on projection pursuit. *Journal of Biopharmaceutical Statistics*, 36(6), 1244-1256. Published online in 2025. [doi:10.1080/10543406.2025.2490725](https://doi.org/10.1080/10543406.2025.2490725).
228
+ - Duan, Y., Cabrera, J., and Emir, B. (2025). A New Projection Pursuit Index for Big Data. *Journal of Computational and Graphical Statistics*, 34(4), 1566-1577. [doi:10.1080/10618600.2025.2468791](https://doi.org/10.1080/10618600.2025.2468791).
229
+ - Cherasia, K. E., Cabrera, J., Fernholz, L. T., and Fernholz, R. (2023). Data Nuggets in Supervised Learning. In M. Yi and K. Nordhausen (eds.), *Robust and Multivariate Statistical Methods: Festschrift in Honor of David E. Tyler* (pp. 429-449). Springer. Published online in 2022. [doi:10.1007/978-3-031-22687-8_20](https://doi.org/10.1007/978-3-031-22687-8_20).
230
+
231
+ The data nugget reduction and weighted clustering methods belong to their original researchers and the maintainers of the R `datanugget` and `WCluster` packages. `datanuggets-flow` builds on the [`datanuggets`](https://github.com/ron2k1/datanuggets) Python port. The scatter gate finder adapts Python code supplied by Prof. Javier Cabrera. The [third-party notices](https://github.com/ron2k1/datanuggetsflowcytometry/blob/main/THIRD_PARTY.md) record the permissions and the upstream licenses.
232
+
233
+ The demonstration files in the app and the recorded test data come from Stefanie Kreutmair and Susanne Unger (2026), *Flow cytometry data of PBMC of critically ill, mechanically ventilated patients* (V1), Zenodo, [doi:10.5281/zenodo.22079206](https://doi.org/10.5281/zenodo.22079206).