| Name | coremstools JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | None |
| Summary | A package for processing CoreMS assignments of ultrahigh mass resolution LC-ESI-MS data |
| upload_time | 2024-09-11 14:13:00 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# CoreMS LC Modules
A Python package for processing CoreMS assignments of ultrahigh mass resolution LC-ESI-MS data.
### Functionality
##### Functions that do not require CoreMS:
- Alignment of assigned features across a dataset
- Calculation of average assignment & feature parameters across a dataset:
1. measured m/z
2. calibrated m/z
3. resolving power
4. m/z error
5. feature S/N
6. confidence score
- Gap filling of ambiguous assignments
- Stoichiometric classifications
- NOSC calucations
- O/C, H/C, N/C calculations
- Identification of significant assignment errors in a dataset, based on rolling average and standard deviation
##### Functions that require CoreMS:
- Determination of a feature's chromatographic dispersity
- Generation of calibrant list(s) for data calibration
- QC checks of retention and intensity of an internal standard across a dataset
### Installation
##### Local editable installation
git clone https://github.com/deweycw/corems-tools.git corems-tools
cd corems-tools/src
python -m pip install -e . # from root directory of project
##### Install pkg from TestPyPi
python -m pip install --index-url https://test.pypi.org/simple/ --no-deps coremstools
### Build and upload to TestPyPi
See: https://packaging.python.org/en/latest/tutorials/packaging-projects/
##### Build prior to uploading to archives
python -m pip install -U build
python -m build
##### Upload to TestPyPi with Twine
python -m pip install -U twine
python -m twine upload --repository testpypi dist/*
### Example Workflow
##### Phase 1: Assignments & initial QC
1. Generate calibrants using calibrant generator function (requires CoreMS)
2. Perform assignments (requires CoreMS)
3. Calculate dispersity (requires CoreMS)
4. Evaluate retention and intensity of internal standard (requires CoreMS)
5. Generate assignment error plots (error v. m/z; error dist in each time window)
##### Phase 2: Alignment, gapfilling, blank correction, error flags
6. Align features across dataset
7. Gapfill across dataset
8. Perform blank correction
9. Flag features with potentially signficant assignment error (i.e., feature is flagged if difference between rolling average of assignment error (across dataset) and error of individual assignment exceeds 4x the standard deviation of the assignment error for the specific feature)
##### Phase 3: Additional classifications
10. Determine O/C, H/C, N/C & NOSC for features
11. Determine stoichiometric classifcations
Raw data
{
"_id": null,
"home_page": null,
"name": "coremstools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Christian Dewey <cdewey@umn.edu>, Rene Boiteau <rboiteau@umn.edu>",
"download_url": "https://files.pythonhosted.org/packages/78/6a/f50f354b27a887bdcb801d13b0c386d9dad4d39b4b461b96c7781f9902f0/coremstools-0.0.2.tar.gz",
"platform": null,
"description": "# CoreMS LC Modules\nA Python package for processing CoreMS assignments of ultrahigh mass resolution LC-ESI-MS data. \n\n### Functionality \n##### Functions that do not require CoreMS:\n- Alignment of assigned features across a dataset\n- Calculation of average assignment & feature parameters across a dataset:\n 1. measured m/z\n 2. calibrated m/z\n 3. resolving power\n 4. m/z error\n 5. feature S/N\n 6. confidence score \n- Gap filling of ambiguous assignments \n- Stoichiometric classifications \n- NOSC calucations \n- O/C, H/C, N/C calculations \n- Identification of significant assignment errors in a dataset, based on rolling average and standard deviation\n\n##### Functions that require CoreMS:\n- Determination of a feature's chromatographic dispersity\n- Generation of calibrant list(s) for data calibration \n- QC checks of retention and intensity of an internal standard across a dataset \n\n### Installation\n\n##### Local editable installation\n git clone https://github.com/deweycw/corems-tools.git corems-tools\n cd corems-tools/src\n python -m pip install -e . # from root directory of project \n\n##### Install pkg from TestPyPi\n python -m pip install --index-url https://test.pypi.org/simple/ --no-deps coremstools\n\n### Build and upload to TestPyPi\nSee: https://packaging.python.org/en/latest/tutorials/packaging-projects/\n\n##### Build prior to uploading to archives\n python -m pip install -U build\n python -m build\n\n##### Upload to TestPyPi with Twine\n python -m pip install -U twine\n python -m twine upload --repository testpypi dist/*\n\n### Example Workflow\n\n##### Phase 1: Assignments & initial QC\n1. Generate calibrants using calibrant generator function (requires CoreMS)\n2. Perform assignments (requires CoreMS)\n3. Calculate dispersity (requires CoreMS)\n4. Evaluate retention and intensity of internal standard (requires CoreMS)\n5. Generate assignment error plots (error v. m/z; error dist in each time window)\n\n##### Phase 2: Alignment, gapfilling, blank correction, error flags\n6. Align features across dataset\n7. Gapfill across dataset \n8. Perform blank correction \n9. Flag features with potentially signficant assignment error (i.e., feature is flagged if difference between rolling average of assignment error (across dataset) and error of individual assignment exceeds 4x the standard deviation of the assignment error for the specific feature) \n\n##### Phase 3: Additional classifications \n10. Determine O/C, H/C, N/C & NOSC for features \n11. Determine stoichiometric classifcations\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A package for processing CoreMS assignments of ultrahigh mass resolution LC-ESI-MS data",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/deweycw/corems-tools",
"Issues": "https://github.com/deweycw/corems-tools/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5ba66dd029b14319d9704f8d45db54de8dabbc969f6153b88afd3c809b4e292a",
"md5": "a482af2c468a2d68171c2359a193c5fc",
"sha256": "3c38a522840ed7e550f4b026c6650ea200228791ff03a5bf9399bbef1d476059"
},
"downloads": -1,
"filename": "coremstools-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a482af2c468a2d68171c2359a193c5fc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 24213,
"upload_time": "2024-09-11T14:12:59",
"upload_time_iso_8601": "2024-09-11T14:12:59.445030Z",
"url": "https://files.pythonhosted.org/packages/5b/a6/6dd029b14319d9704f8d45db54de8dabbc969f6153b88afd3c809b4e292a/coremstools-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "786af50f354b27a887bdcb801d13b0c386d9dad4d39b4b461b96c7781f9902f0",
"md5": "7e11fe92fcd743be12285aec7594375e",
"sha256": "9a7a341e5952dd7c3bd81242155ee7a686cca20e2d837c92e3be5ad7d3d51aa6"
},
"downloads": -1,
"filename": "coremstools-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "7e11fe92fcd743be12285aec7594375e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 20914,
"upload_time": "2024-09-11T14:13:00",
"upload_time_iso_8601": "2024-09-11T14:13:00.932872Z",
"url": "https://files.pythonhosted.org/packages/78/6a/f50f354b27a887bdcb801d13b0c386d9dad4d39b4b461b96c7781f9902f0/coremstools-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-11 14:13:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "deweycw",
"github_project": "corems-tools",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "coremstools"
}
