protdata 0.1.3__tar.gz → 0.1.4__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.
protdata-0.1.4/LICENSE ADDED
@@ -0,0 +1,28 @@
1
+ BSD 3-Clause License
2
+
3
+ Copyright (c) 2025, Chan Zuckerberg Biohub
4
+
5
+ Redistribution and use in source and binary forms, with or without
6
+ modification, are permitted provided that the following conditions are met:
7
+
8
+ 1. Redistributions of source code must retain the above copyright notice, this
9
+ list of conditions and the following disclaimer.
10
+
11
+ 2. Redistributions in binary form must reproduce the above copyright notice,
12
+ this list of conditions and the following disclaimer in the documentation
13
+ and/or other materials provided with the distribution.
14
+
15
+ 3. Neither the name of the copyright holder nor the names of its
16
+ contributors may be used to endorse or promote products derived from
17
+ this software without specific prior written permission.
18
+
19
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: protdata
3
- Version: 0.1.3
3
+ Version: 0.1.4
4
4
  Summary: Proteomics data loaders for AnnData format.
5
5
  Author: Max Frank
6
6
  License-Expression: MIT
@@ -32,6 +32,7 @@ Requires-Dist: sphinx-issues>=5.0.1; extra == "docs"
32
32
  Requires-Dist: sphinx-copybutton; extra == "docs"
33
33
  Requires-Dist: sphinx-toolbox>=3.8.0; extra == "docs"
34
34
  Requires-Dist: sphinxext.opengraph; extra == "docs"
35
+ Requires-Dist: sphinx_design; extra == "docs"
35
36
  Requires-Dist: myst-nb; extra == "docs"
36
37
  Requires-Dist: scanpydoc[theme,typehints]>=0.15.3; extra == "docs"
37
38
  Requires-Dist: awkward>=2.3; extra == "docs"
@@ -42,6 +43,8 @@ Dynamic: license-file
42
43
  # protdata
43
44
 
44
45
  [![Test](https://github.com/czbiohub-sf/protdata/actions/workflows/test.yml/badge.svg)](https://github.com/czbiohub-sf/protdata/actions/workflows/test.yml)
46
+ ![PyPI - Version](https://img.shields.io/pypi/v/protdata)
47
+ [![docs online](https://img.shields.io/badge/docs-online-blue)](https://protdata-czbiohub.vercel.app/)
45
48
 
46
49
  Proteomics data loaders for the [AnnData](https://anndata.readthedocs.io/) format.
47
50
 
@@ -53,25 +56,37 @@ This package provides loader functions to import proteomics data (e.g., MaxQuant
53
56
  - **Reads metadata**: Automatically extracts and organizes sample and protein metadata
54
57
 
55
58
  ## Installation
59
+
60
+ Protdata has minimal dependencies listed in [pyproject.toml](https://github.com/czbiohub-sf/protdata/blob/main/pyproject.toml)
61
+
62
+ To install the latest release from PyPI, run:
63
+
56
64
  ```bash
57
65
  pip install protdata
58
66
  ```
59
67
 
68
+ Or install from source:
69
+ ```bash
70
+ git clone https://github.com/czbiohub-sf/protdata.git
71
+ cd protdata
72
+ pip install -e . # or make setup-develop for developers
73
+ ```
74
+
60
75
  ## Usage Example
61
76
 
62
77
  ### MaxQuant Import
63
78
 
64
- You can download an example proteinGroups [file here](https://zenodo.org/records/3774452/files/MaxQuant_Protein_Groups.tabular?download=1)
79
+ You can download an example proteinGroups [file here](https://github.com/czbiohub-sf/protdata/raw/main/data/proteinGroups.txt)
65
80
  ```python
66
81
  import protdata
67
82
 
68
83
  adata = load_maxquant_to_anndata("/path/to/proteinGroups.txt")
69
84
  print(adata)
70
- ```
85
+ ```
71
86
 
72
87
  ### DIA-NN Import
73
88
 
74
- You can download an example DIA-NN report [file here](https://github.com/vdemichev/DiaNN/raw/master/diann-output-examples/report.pg_matrix.tsv)
89
+ You can download an example DIA-NN report [file here](https://github.com/czbiohub-sf/protdata/raw/main/data/report.pg_matrix.tsv)
75
90
 
76
91
  ```python
77
92
  from protdata.io import read_diann
@@ -82,7 +97,7 @@ print(adata)
82
97
 
83
98
  ### FragPipe Import
84
99
 
85
- You can download an example FragPipe output [file here](https://github.com/Nesvilab/philosopher/blob/master/testdata/combined_protein.tsv?raw=true)
100
+ You can download an example FragPipe output [file here](https://github.com/czbiohub-sf/protdata/raw/main/data/combined_protein.tsv)
86
101
 
87
102
  ```python
88
103
  from protdata.io import read_fragpipe
@@ -93,7 +108,7 @@ print(adata)
93
108
 
94
109
  ### mzTab Import
95
110
 
96
- You can download an example mzTab [file here](https://raw.githubusercontent.com/HUPO-PSI/mzTab/refs/heads/master/examples/1_0-Proteomics-Release/SILAC_SQ.mzTab)
111
+ You can download an example mzTab [file here](https://github.com/czbiohub-sf/protdata/raw/main/data/SILAC_SQ.mzTab)
97
112
 
98
113
  ```python
99
114
  from protdata.io import read_mztab
@@ -101,6 +116,15 @@ from protdata.io import read_mztab
101
116
  adata = read_mztab("/path/to/SILAC_SQ.mzTab")
102
117
  print(adata)
103
118
  ```
119
+ ## Authors
120
+
121
+ `protdata` is created and maintained by the [Computational Biology Platform](https://www.czbiohub.org/comp-biology/) at the [Chan Zuckerberg Biohub San Francisco](https://www.czbiohub.org/sf/).
122
+
123
+ To get in touch please use the [GihHub issues](https://github.com/czbiohub-sf/protdata/issues) page.
104
124
 
125
+ ## Contributing
105
126
 
127
+ If you want to contribute to `protdata`, please read the [Contribution Guide](https://prodata.sf.czbiohub.org/contributing)
106
128
 
129
+ ## Changelog
130
+ See [Release Notes](https://prodata.sf.czbiohub.org/release_notes)
@@ -0,0 +1,88 @@
1
+ # protdata
2
+
3
+ [![Test](https://github.com/czbiohub-sf/protdata/actions/workflows/test.yml/badge.svg)](https://github.com/czbiohub-sf/protdata/actions/workflows/test.yml)
4
+ ![PyPI - Version](https://img.shields.io/pypi/v/protdata)
5
+ [![docs online](https://img.shields.io/badge/docs-online-blue)](https://protdata-czbiohub.vercel.app/)
6
+
7
+ Proteomics data loaders for the [AnnData](https://anndata.readthedocs.io/) format.
8
+
9
+ This package provides loader functions to import proteomics data (e.g., MaxQuant) into the AnnData structure for downstream analysis and integration with single-cell and multi-omics workflows.
10
+
11
+ ## Features
12
+
13
+ - **Multiple formats**: Support for MaxQuant, FragPipe, DIA-NN, and mzTab files
14
+ - **Reads metadata**: Automatically extracts and organizes sample and protein metadata
15
+
16
+ ## Installation
17
+
18
+ Protdata has minimal dependencies listed in [pyproject.toml](https://github.com/czbiohub-sf/protdata/blob/main/pyproject.toml)
19
+
20
+ To install the latest release from PyPI, run:
21
+
22
+ ```bash
23
+ pip install protdata
24
+ ```
25
+
26
+ Or install from source:
27
+ ```bash
28
+ git clone https://github.com/czbiohub-sf/protdata.git
29
+ cd protdata
30
+ pip install -e . # or make setup-develop for developers
31
+ ```
32
+
33
+ ## Usage Example
34
+
35
+ ### MaxQuant Import
36
+
37
+ You can download an example proteinGroups [file here](https://github.com/czbiohub-sf/protdata/raw/main/data/proteinGroups.txt)
38
+ ```python
39
+ import protdata
40
+
41
+ adata = load_maxquant_to_anndata("/path/to/proteinGroups.txt")
42
+ print(adata)
43
+ ```
44
+
45
+ ### DIA-NN Import
46
+
47
+ You can download an example DIA-NN report [file here](https://github.com/czbiohub-sf/protdata/raw/main/data/report.pg_matrix.tsv)
48
+
49
+ ```python
50
+ from protdata.io import read_diann
51
+
52
+ adata = read_diann("/path/to/report.pg_matrix.tsv")
53
+ print(adata)
54
+ ```
55
+
56
+ ### FragPipe Import
57
+
58
+ You can download an example FragPipe output [file here](https://github.com/czbiohub-sf/protdata/raw/main/data/combined_protein.tsv)
59
+
60
+ ```python
61
+ from protdata.io import read_fragpipe
62
+
63
+ adata = read_fragpipe("/path/to/combined_protein.tsv")
64
+ print(adata)
65
+ ```
66
+
67
+ ### mzTab Import
68
+
69
+ You can download an example mzTab [file here](https://github.com/czbiohub-sf/protdata/raw/main/data/SILAC_SQ.mzTab)
70
+
71
+ ```python
72
+ from protdata.io import read_mztab
73
+
74
+ adata = read_mztab("/path/to/SILAC_SQ.mzTab")
75
+ print(adata)
76
+ ```
77
+ ## Authors
78
+
79
+ `protdata` is created and maintained by the [Computational Biology Platform](https://www.czbiohub.org/comp-biology/) at the [Chan Zuckerberg Biohub San Francisco](https://www.czbiohub.org/sf/).
80
+
81
+ To get in touch please use the [GihHub issues](https://github.com/czbiohub-sf/protdata/issues) page.
82
+
83
+ ## Contributing
84
+
85
+ If you want to contribute to `protdata`, please read the [Contribution Guide](https://prodata.sf.czbiohub.org/contributing)
86
+
87
+ ## Changelog
88
+ See [Release Notes](https://prodata.sf.czbiohub.org/release_notes)
@@ -27,6 +27,7 @@ master_doc = "index"
27
27
  default_role = "literal"
28
28
  exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**.ipynb_checkpoints"]
29
29
  pygments_style = "sphinx"
30
+ html_favicon = "_static/img/protdata_favicon.svg"
30
31
 
31
32
  extensions = [
32
33
  "myst_nb",
@@ -27,12 +27,11 @@ def read_diann(
27
27
 
28
28
  Returns
29
29
  -------
30
- anndata.AnnData
31
- AnnData object with:
30
+ :class:`anndata.AnnData` object with:
32
31
 
33
- - X: intensity matrix (samples x proteins)
34
- - var: protein metadata (indexed by protein group IDs)
35
- - obs: sample metadata (indexed by sample names)
32
+ - ``X``: intensity matrix (samples x proteins)
33
+ - ``var``: protein metadata (indexed by protein group IDs)
34
+ - ``obs``: sample metadata (indexed by sample names)
36
35
  """
37
36
  if isinstance(file, pd.DataFrame):
38
37
  df = file.copy()
@@ -1,8 +1,10 @@
1
- import pandas as pd
2
- import numpy as np
3
- import anndata as ad
4
- from typing import Union
5
1
  import warnings
2
+ from typing import Union
3
+
4
+ import anndata as ad
5
+ import numpy as np
6
+ import pandas as pd
7
+
6
8
  from .utils import cleanup_obsvar
7
9
 
8
10
 
@@ -33,13 +35,12 @@ def read_fragpipe(
33
35
 
34
36
  Returns
35
37
  -------
36
- anndata.AnnData
37
- AnnData object with:
38
+ :class:`anndata.AnnData` object with:
38
39
 
39
- - X: intensity matrix (samples x proteins)
40
- - var: protein metadata (indexed by protein IDs)
41
- - obs: sample metadata (indexed by sample names)
42
- - layers: additional intensity matrices if multiple intensity column suffixes are provided
40
+ - ``X``: intensity matrix (samples x proteins)
41
+ - ``var``: protein metadata (indexed by protein IDs)
42
+ - ``obs``: sample metadata (indexed by sample names)
43
+ - ``layers``: additional intensity matrices if multiple intensity column suffixes are provided
43
44
  """
44
45
  if isinstance(intensity_column_suffixes, str):
45
46
  intensity_column_suffixes = [intensity_column_suffixes]
@@ -45,13 +45,12 @@ def read_maxquant(
45
45
 
46
46
  Returns
47
47
  -------
48
- anndata.AnnData
49
- AnnData object with:
48
+ :class:`anndata.AnnData` object with:
50
49
 
51
- - X: intensity matrix (samples x proteins)
52
- - var: protein metadata (indexed by protein IDs)
53
- - obs: sample metadata (indexed by sample names)
54
- - layers: additional intensity matrices if multiple intensity column prefixes are provided
50
+ - ``X``: intensity matrix (samples x proteins)
51
+ - ``var``: protein metadata (indexed by protein IDs)
52
+ - ``obs``: sample metadata (indexed by sample names)
53
+ - ``layers``: additional intensity matrices if multiple intensity column prefixes are provided
55
54
  """
56
55
  if isinstance(intensity_column_prefixes, str):
57
56
  intensity_column_prefixes = [intensity_column_prefixes]
@@ -24,12 +24,11 @@ def read_mztab(
24
24
 
25
25
  Returns
26
26
  -------
27
- anndata.AnnData
28
- AnnData object with:
27
+ :class:`anndata.AnnData` object with:
29
28
 
30
- - X: intensity matrix (proteins x samples)
31
- - var: protein metadata (indexed by protein accession)
32
- - obs: sample metadata (indexed by sample names)
29
+ - ``X``: intensity matrix (samples x proteins)
30
+ - ``var``: protein metadata (indexed by protein accession)
31
+ - ``obs``: sample metadata (indexed by sample names)
33
32
  """
34
33
  if isinstance(file, pd.DataFrame):
35
34
  df = file.copy()
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: protdata
3
- Version: 0.1.3
3
+ Version: 0.1.4
4
4
  Summary: Proteomics data loaders for AnnData format.
5
5
  Author: Max Frank
6
6
  License-Expression: MIT
@@ -32,6 +32,7 @@ Requires-Dist: sphinx-issues>=5.0.1; extra == "docs"
32
32
  Requires-Dist: sphinx-copybutton; extra == "docs"
33
33
  Requires-Dist: sphinx-toolbox>=3.8.0; extra == "docs"
34
34
  Requires-Dist: sphinxext.opengraph; extra == "docs"
35
+ Requires-Dist: sphinx_design; extra == "docs"
35
36
  Requires-Dist: myst-nb; extra == "docs"
36
37
  Requires-Dist: scanpydoc[theme,typehints]>=0.15.3; extra == "docs"
37
38
  Requires-Dist: awkward>=2.3; extra == "docs"
@@ -42,6 +43,8 @@ Dynamic: license-file
42
43
  # protdata
43
44
 
44
45
  [![Test](https://github.com/czbiohub-sf/protdata/actions/workflows/test.yml/badge.svg)](https://github.com/czbiohub-sf/protdata/actions/workflows/test.yml)
46
+ ![PyPI - Version](https://img.shields.io/pypi/v/protdata)
47
+ [![docs online](https://img.shields.io/badge/docs-online-blue)](https://protdata-czbiohub.vercel.app/)
45
48
 
46
49
  Proteomics data loaders for the [AnnData](https://anndata.readthedocs.io/) format.
47
50
 
@@ -53,25 +56,37 @@ This package provides loader functions to import proteomics data (e.g., MaxQuant
53
56
  - **Reads metadata**: Automatically extracts and organizes sample and protein metadata
54
57
 
55
58
  ## Installation
59
+
60
+ Protdata has minimal dependencies listed in [pyproject.toml](https://github.com/czbiohub-sf/protdata/blob/main/pyproject.toml)
61
+
62
+ To install the latest release from PyPI, run:
63
+
56
64
  ```bash
57
65
  pip install protdata
58
66
  ```
59
67
 
68
+ Or install from source:
69
+ ```bash
70
+ git clone https://github.com/czbiohub-sf/protdata.git
71
+ cd protdata
72
+ pip install -e . # or make setup-develop for developers
73
+ ```
74
+
60
75
  ## Usage Example
61
76
 
62
77
  ### MaxQuant Import
63
78
 
64
- You can download an example proteinGroups [file here](https://zenodo.org/records/3774452/files/MaxQuant_Protein_Groups.tabular?download=1)
79
+ You can download an example proteinGroups [file here](https://github.com/czbiohub-sf/protdata/raw/main/data/proteinGroups.txt)
65
80
  ```python
66
81
  import protdata
67
82
 
68
83
  adata = load_maxquant_to_anndata("/path/to/proteinGroups.txt")
69
84
  print(adata)
70
- ```
85
+ ```
71
86
 
72
87
  ### DIA-NN Import
73
88
 
74
- You can download an example DIA-NN report [file here](https://github.com/vdemichev/DiaNN/raw/master/diann-output-examples/report.pg_matrix.tsv)
89
+ You can download an example DIA-NN report [file here](https://github.com/czbiohub-sf/protdata/raw/main/data/report.pg_matrix.tsv)
75
90
 
76
91
  ```python
77
92
  from protdata.io import read_diann
@@ -82,7 +97,7 @@ print(adata)
82
97
 
83
98
  ### FragPipe Import
84
99
 
85
- You can download an example FragPipe output [file here](https://github.com/Nesvilab/philosopher/blob/master/testdata/combined_protein.tsv?raw=true)
100
+ You can download an example FragPipe output [file here](https://github.com/czbiohub-sf/protdata/raw/main/data/combined_protein.tsv)
86
101
 
87
102
  ```python
88
103
  from protdata.io import read_fragpipe
@@ -93,7 +108,7 @@ print(adata)
93
108
 
94
109
  ### mzTab Import
95
110
 
96
- You can download an example mzTab [file here](https://raw.githubusercontent.com/HUPO-PSI/mzTab/refs/heads/master/examples/1_0-Proteomics-Release/SILAC_SQ.mzTab)
111
+ You can download an example mzTab [file here](https://github.com/czbiohub-sf/protdata/raw/main/data/SILAC_SQ.mzTab)
97
112
 
98
113
  ```python
99
114
  from protdata.io import read_mztab
@@ -101,6 +116,15 @@ from protdata.io import read_mztab
101
116
  adata = read_mztab("/path/to/SILAC_SQ.mzTab")
102
117
  print(adata)
103
118
  ```
119
+ ## Authors
120
+
121
+ `protdata` is created and maintained by the [Computational Biology Platform](https://www.czbiohub.org/comp-biology/) at the [Chan Zuckerberg Biohub San Francisco](https://www.czbiohub.org/sf/).
122
+
123
+ To get in touch please use the [GihHub issues](https://github.com/czbiohub-sf/protdata/issues) page.
104
124
 
125
+ ## Contributing
105
126
 
127
+ If you want to contribute to `protdata`, please read the [Contribution Guide](https://prodata.sf.czbiohub.org/contributing)
106
128
 
129
+ ## Changelog
130
+ See [Release Notes](https://prodata.sf.czbiohub.org/release_notes)
@@ -20,6 +20,7 @@ sphinx-issues>=5.0.1
20
20
  sphinx-copybutton
21
21
  sphinx-toolbox>=3.8.0
22
22
  sphinxext.opengraph
23
+ sphinx_design
23
24
  myst-nb
24
25
  scanpydoc[theme,typehints]>=0.15.3
25
26
  awkward>=2.3
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "protdata"
3
- version = "0.1.3"
3
+ version = "0.1.4"
4
4
  description = "Proteomics data loaders for AnnData format."
5
5
  requires-python = ">=3.9, <4.0"
6
6
  authors = [
@@ -41,6 +41,7 @@ docs = [
41
41
  "sphinx-copybutton",
42
42
  "sphinx-toolbox>=3.8.0",
43
43
  "sphinxext.opengraph",
44
+ "sphinx_design",
44
45
  "myst-nb",
45
46
  "scanpydoc[theme,typehints] >=0.15.3",
46
47
  "awkward>=2.3",
@@ -52,5 +53,35 @@ docs = [
52
53
  requires = ["setuptools>=61.0"]
53
54
  build-backend = "setuptools.build_meta"
54
55
 
56
+ [tool.black]
57
+ exclude = '''
58
+ /(
59
+ \.eggs
60
+ | \.git
61
+ | \.hg
62
+ | \.mypy_cache
63
+ | \.tox
64
+ | \.venv
65
+ | _build
66
+ | buck-out
67
+ | build
68
+ | dist
69
+ | data
70
+ )/
71
+ '''
72
+
73
+ [tool.flake8]
74
+ exclude = [
75
+ ".git",
76
+ "__pycache__",
77
+ "docs/source/conf.py",
78
+ "build",
79
+ "dist",
80
+ "data",
81
+ ]
82
+
83
+ [tool.pylint]
84
+ ignore-paths = ["data"]
85
+
55
86
  [tool.setuptools.packages.find]
56
87
  where = ["."]
@@ -1,8 +1,11 @@
1
1
  import os
2
- import pytest
2
+
3
3
  import anndata as ad
4
- from protdata.io.maxquant_loader import read_maxquant
4
+ import pytest
5
+
6
+ from protdata.io.diann_loader import read_diann
5
7
  from protdata.io.fragpipe_loader import read_fragpipe
8
+ from protdata.io.maxquant_loader import read_maxquant
6
9
  from protdata.io.mztab_loader import read_mztab
7
10
 
8
11
  data_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), "../data"))
@@ -14,6 +17,7 @@ data_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), "../data"))
14
17
  ("proteinGroups.txt", read_maxquant),
15
18
  ("combined_protein.tsv", read_fragpipe),
16
19
  ("SILAC_SQ.mzTab", read_mztab),
20
+ ("report.pg_matrix.tsv", read_diann),
17
21
  ],
18
22
  )
19
23
  def test_loader(filename, loader, tmp_path):
protdata-0.1.3/LICENSE DELETED
@@ -1,11 +0,0 @@
1
- # Released under MIT License
2
-
3
- Copyright (c) 2013 Mark Otto.
4
-
5
- Copyright (c) 2017 Andrew Fong.
6
-
7
- Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
8
-
9
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
10
-
11
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
protdata-0.1.3/README.md DELETED
@@ -1,65 +0,0 @@
1
- # protdata
2
-
3
- [![Test](https://github.com/czbiohub-sf/protdata/actions/workflows/test.yml/badge.svg)](https://github.com/czbiohub-sf/protdata/actions/workflows/test.yml)
4
-
5
- Proteomics data loaders for the [AnnData](https://anndata.readthedocs.io/) format.
6
-
7
- This package provides loader functions to import proteomics data (e.g., MaxQuant) into the AnnData structure for downstream analysis and integration with single-cell and multi-omics workflows.
8
-
9
- ## Features
10
-
11
- - **Multiple formats**: Support for MaxQuant, FragPipe, DIA-NN, and mzTab files
12
- - **Reads metadata**: Automatically extracts and organizes sample and protein metadata
13
-
14
- ## Installation
15
- ```bash
16
- pip install protdata
17
- ```
18
-
19
- ## Usage Example
20
-
21
- ### MaxQuant Import
22
-
23
- You can download an example proteinGroups [file here](https://zenodo.org/records/3774452/files/MaxQuant_Protein_Groups.tabular?download=1)
24
- ```python
25
- import protdata
26
-
27
- adata = load_maxquant_to_anndata("/path/to/proteinGroups.txt")
28
- print(adata)
29
- ```
30
-
31
- ### DIA-NN Import
32
-
33
- You can download an example DIA-NN report [file here](https://github.com/vdemichev/DiaNN/raw/master/diann-output-examples/report.pg_matrix.tsv)
34
-
35
- ```python
36
- from protdata.io import read_diann
37
-
38
- adata = read_diann("/path/to/report.pg_matrix.tsv")
39
- print(adata)
40
- ```
41
-
42
- ### FragPipe Import
43
-
44
- You can download an example FragPipe output [file here](https://github.com/Nesvilab/philosopher/blob/master/testdata/combined_protein.tsv?raw=true)
45
-
46
- ```python
47
- from protdata.io import read_fragpipe
48
-
49
- adata = read_fragpipe("/path/to/combined_protein.tsv")
50
- print(adata)
51
- ```
52
-
53
- ### mzTab Import
54
-
55
- You can download an example mzTab [file here](https://raw.githubusercontent.com/HUPO-PSI/mzTab/refs/heads/master/examples/1_0-Proteomics-Release/SILAC_SQ.mzTab)
56
-
57
- ```python
58
- from protdata.io import read_mztab
59
-
60
- adata = read_mztab("/path/to/SILAC_SQ.mzTab")
61
- print(adata)
62
- ```
63
-
64
-
65
-
File without changes
File without changes
File without changes