parseet 0.2.0__py3-none-any.whl

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.
parseet/version.py ADDED
@@ -0,0 +1 @@
1
+ __version__ = "0.2.0"
@@ -0,0 +1,56 @@
1
+ Metadata-Version: 2.1
2
+ Name: parseet
3
+ Version: 0.2.0
4
+ Summary: This package is used to parse ms samplesheet for further analyses.
5
+ Keywords: samplesheet,parser,data analyses,mass spectrometry,msdial
6
+ Author-Email: Matteo Miotto <miotsdata@gmail.com>
7
+ License: MIT
8
+ Classifier: Programming Language :: Python :: 3
9
+ Classifier: License :: OSI Approved :: MIT License
10
+ Classifier: Operating System :: OS Independent
11
+ Requires-Python: <3.13,>=3.12
12
+ Requires-Dist: pandas>=2.3.3
13
+ Requires-Dist: openpyxl>=3.1.5
14
+ Provides-Extra: gui
15
+ Requires-Dist: pyside6>=6.11.1; extra == "gui"
16
+ Description-Content-Type: text/markdown
17
+
18
+ # BULK METABOLOMICS SAMPLESHEET
19
+
20
+ This folder contains the files necessary for the samplesheet of LC-MS and spatial metabolomics.
21
+ Samplesheet template (LC-MS_metabolomics_samplesheet.xlsx or spatial_metabolomics_samplesheet.xlsx) should be given to clients to be compiled. Once received back, it should be tested with the parser (LC-MS_parse_samplesheet.py or spatial_parse_samplesheet.py).
22
+
23
+ ## Samplesheet template
24
+ Samplesheet templates contains 3 sheets:
25
+
26
+ - input: the one the user should fill. It contains two sections, one with user info and the other with samples metadata.
27
+ - example_ok: an example of a good samplesheet
28
+ - example_fail: an example of a problematic samplesheet
29
+
30
+ ## Parser
31
+ The parser will check the samplesheet for its correct compilation and raises warnings and/or errors if any.
32
+ If no errors are found, the samples metadata section is saved as a csv file (specified as -o). Warnings also prevent file to be saved, but this can be overruled by --ignore-warnings.
33
+
34
+ ## Test
35
+ In test folder, 3 test samplesheet for each technology are found:
36
+
37
+ - test_error.xlsx: a test samplesheet with errrors
38
+ - test_ok.xlsx: a test samplesheet correctly compiled
39
+ - test_warning.xlsx: a test samplesheet with warnings
40
+
41
+ Several test should be run after changind any file:
42
+
43
+ - `python LC-MS_parse_samplesheet.py` (this should result in an error for missing input and output)
44
+ - `python LC-MS_parse_samplesheet.py -i test_files/LC-MS_test_ok.xlsx -o test.csv --dry-run` (this should be ok, with no errors nor warnings, but no file should be saved due to --dry-run)
45
+ - `python LC-MS_parse_samplesheet.py -i test_files/LC-MS_test_ok.xlsx -o test.csv` (this should be ok, with also test.csv file saved)
46
+ - `python LC-MS_parse_samplesheet.py -i test_files/LC-MS_test_error.xlsx -o test.csv` (this should raise errors and no test.csv file should be created)
47
+ - `python LC-MS_parse_samplesheet.py -i test_files/LC-MS_test_warning.xlsx -o test.csv` (this should raise warnings and no test.csv file should be created)
48
+ - `python LC-MS_parse_samplesheet.py` (this should result in an error for missing input and output)
49
+ - `python spatial_parse_samplesheet.py -i test_files/spatial_test_ok.xlsx -o test.csv --dry-run` (this should be ok, with no errors nor warnings, but no file should be saved due to --dry-run)
50
+ - `python LC-MS_parse_samplesheet.py -i test_files/LC-MS_test_ok_timecourse.xlsx -o test.csv` (this should be ok, with also test.csv file saved)
51
+ - `python spatial_parse_samplesheet.py -i test_files/spatial_test_ok.xlsx -o test.csv` (this should be ok, with also test.csv file saved)
52
+ - `python spatial_parse_samplesheet.py -i test_files/spatial_test_error.xlsx -o test.csv` (this should raise errors and no test.csv file should be created)
53
+ - `python spatial_parse_samplesheet.py -i test_files/spatial_test_warning.xlsx -o test.csv` (this should raise warnings and no test.csv file should be created)
54
+ - `python spatial_parse_samplesheet.py -i test_files/spatial_test_warning.xlsx -o test.csv` --ignore-warnings (this should raise warnings, but test.csv file should be created)
55
+ - `python spatial_parse_samplesheet.py -i test_files/spatial_test_warning.xlsx -o test.csv` --ignore-warnings (this should raise warnings, but test.csv file should be created)
56
+
@@ -0,0 +1,20 @@
1
+ parseet-0.2.0.dist-info/METADATA,sha256=LwzSWJninvl0DRPZQROYNvGEuatsjB5fCp3hM2uaivs,3850
2
+ parseet-0.2.0.dist-info/WHEEL,sha256=VP-D4TPS230sME9Z3vb3INXvo1yt0924YRm5AOsk_dE,90
3
+ parseet-0.2.0.dist-info/entry_points.txt,sha256=oeHTCaYLLZDEnS0MJsV70nIccIwm07x6UJdE5wQZrBw,92
4
+ parseet/.DS_Store,sha256=2JvCSFIsKyVMbIw8qiMatTYqT5qOo0VsZmsEPvMewLk,6148
5
+ parseet/__init__.py,sha256=GHEf4nhn6gJbfBITKMN7tKuwGjNimb4Cb5GpR1HKeQc,55
6
+ parseet/app.py,sha256=D8-7h_vXFwCVwpFVXqAY1LEWWVn94AtZibJ90OPQhZs,1558
7
+ parseet/backend.py,sha256=yW3VM2EQ5caB4JqM0u-IBBPHxIS5o4AIxnO9wRI-EFw,8667
8
+ parseet/cli.py,sha256=ss_IilqVlQBZnuekJqNdpxoqP942ZThRKI_MXkTpPa4,4485
9
+ parseet/config/__init__.py,sha256=d62R6gvvBMpoLft5lCHZHAcWt1u7zcuWC-2nynNqw7U,152
10
+ parseet/config/config.toml,sha256=eh1LornHdz8cwbm5AjLStXjzxMQNSlgasFLNmvl_QxI,67
11
+ parseet/core/single_process.py,sha256=ybmlMpR3mJQi1yWTqMI8rIaNzuKSD2pzHJtDvDRQXMg,1843
12
+ parseet/core/utils/__init__.py,sha256=LSj4k3yK7ScLj3ycXjR_RCxwjPQ6Rdm67UTuMwoy1P0,223
13
+ parseet/core/utils/build_parser.py,sha256=Hrn9Jq4LZq7OqKU-qh4oP3BCJdAwwaPKQx4PEx-zAZc,1479
14
+ parseet/core/utils/check_order.py,sha256=dnjxHomb3_JPAx1GH-LNHN8fIvMIUfrO_O-yCbfZKLo,14417
15
+ parseet/core/utils/lcms_check_samples.py,sha256=I63s1T0V2vCYeLIPQeiwj95XypL-IuDcXxlNKy99bLs,12228
16
+ parseet/core/utils/parse_samplesheet.py,sha256=0pj8vGhDisQAzCRrz42FWmuEhxrLZL0Uym606sPQnTs,12608
17
+ parseet/core/utils/setup_logger.py,sha256=dAIBFD69i-wPDrm3pNVeVqQqA9_xO1wuwzinQpDEQEQ,565
18
+ parseet/main.qml,sha256=TBhyub_F-uiGzByOz0vDzIxTgAyWrp4eI74F4i9exHA,41015
19
+ parseet/version.py,sha256=Zn1KFblwuFHiDRdRAiRnDBRkbPttWh44jKa5zG2ov0E,22
20
+ parseet-0.2.0.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: pdm-backend (2.4.9)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
@@ -0,0 +1,6 @@
1
+ [console_scripts]
2
+ parseet = parseet.cli:main
3
+
4
+ [gui_scripts]
5
+ parseet-gui = parseet.app:main
6
+