SingleCellExperiment 0.2.5__tar.gz → 0.3.0__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 (52) hide show
  1. SingleCellExperiment-0.3.0/.pre-commit-config.yaml +67 -0
  2. SingleCellExperiment-0.3.0/CONTRIBUTING.md +371 -0
  3. {SingleCellExperiment-0.2.5/src/SingleCellExperiment.egg-info → SingleCellExperiment-0.3.0}/PKG-INFO +6 -6
  4. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/README.md +5 -5
  5. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/docs/conf.py +28 -20
  6. SingleCellExperiment-0.3.0/docs/contributing.md +4 -0
  7. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/docs/index.md +15 -13
  8. SingleCellExperiment-0.3.0/docs/license.md +5 -0
  9. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/docs/readme.md +5 -5
  10. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/docs/requirements.txt +1 -2
  11. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/docs/tutorial.md +24 -17
  12. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/pyproject.toml +18 -0
  13. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/setup.cfg +5 -3
  14. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/setup.py +1 -1
  15. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0/src/SingleCellExperiment.egg-info}/PKG-INFO +6 -6
  16. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/src/SingleCellExperiment.egg-info/SOURCES.txt +5 -3
  17. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/src/SingleCellExperiment.egg-info/requires.txt +1 -1
  18. SingleCellExperiment-0.3.0/src/singlecellexperiment/SingleCellExperiment.py +555 -0
  19. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/src/singlecellexperiment/__init__.py +4 -10
  20. SingleCellExperiment-0.3.0/src/singlecellexperiment/_types.py +11 -0
  21. SingleCellExperiment-0.3.0/src/singlecellexperiment/io/__init__.py +2 -0
  22. SingleCellExperiment-0.3.0/src/singlecellexperiment/io/anndata.py +70 -0
  23. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/src/singlecellexperiment/io/tenx.py +19 -12
  24. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/tests/test_sce.py +27 -16
  25. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/tests/test_sce_io.py +29 -24
  26. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/tests/test_sce_methods.py +34 -28
  27. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/tests/test_sce_slice.py +23 -17
  28. SingleCellExperiment-0.2.5/CONTRIBUTING.rst +0 -353
  29. SingleCellExperiment-0.2.5/docs/contributing.rst +0 -1
  30. SingleCellExperiment-0.2.5/docs/license.rst +0 -7
  31. SingleCellExperiment-0.2.5/src/singlecellexperiment/SingleCellExperiment.py +0 -571
  32. SingleCellExperiment-0.2.5/src/singlecellexperiment/io/__init__.py +0 -2
  33. SingleCellExperiment-0.2.5/src/singlecellexperiment/io/anndata.py +0 -65
  34. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/.coveragerc +0 -0
  35. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/.github/workflows/pypi-publish.yml +0 -0
  36. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/.github/workflows/pypi-test.yml +0 -0
  37. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/.gitignore +0 -0
  38. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/.readthedocs.yml +0 -0
  39. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/AUTHORS.md +0 -0
  40. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/CHANGELOG.md +0 -0
  41. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/LICENSE.txt +0 -0
  42. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/docs/Makefile +0 -0
  43. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/docs/_static/.gitignore +0 -0
  44. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/docs/authors.md +0 -0
  45. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/docs/changelog.md +0 -0
  46. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/src/SingleCellExperiment.egg-info/dependency_links.txt +0 -0
  47. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/src/SingleCellExperiment.egg-info/not-zip-safe +0 -0
  48. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/src/SingleCellExperiment.egg-info/top_level.txt +0 -0
  49. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/tests/conftest.py +0 -0
  50. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/tests/data/adata.h5ad +0 -0
  51. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/tests/data/tenx.sub.h5 +0 -0
  52. {SingleCellExperiment-0.2.5 → SingleCellExperiment-0.3.0}/tox.ini +0 -0
@@ -0,0 +1,67 @@
1
+ exclude: '^docs/conf.py'
2
+
3
+ repos:
4
+ - repo: https://github.com/pre-commit/pre-commit-hooks
5
+ rev: v4.4.0
6
+ hooks:
7
+ - id: trailing-whitespace
8
+ - id: check-added-large-files
9
+ - id: check-ast
10
+ - id: check-json
11
+ - id: check-merge-conflict
12
+ - id: check-xml
13
+ - id: check-yaml
14
+ - id: debug-statements
15
+ - id: end-of-file-fixer
16
+ - id: requirements-txt-fixer
17
+ - id: mixed-line-ending
18
+ args: ['--fix=auto'] # replace 'auto' with 'lf' to enforce Linux/Mac line endings or 'crlf' for Windows
19
+
20
+ ## If you want to automatically "modernize" your Python code:
21
+ # - repo: https://github.com/asottile/pyupgrade
22
+ # rev: v3.7.0
23
+ # hooks:
24
+ # - id: pyupgrade
25
+ # args: ['--py37-plus']
26
+
27
+ ## If you want to avoid flake8 errors due to unused vars or imports:
28
+ # - repo: https://github.com/PyCQA/autoflake
29
+ # rev: v2.1.1
30
+ # hooks:
31
+ # - id: autoflake
32
+ # args: [
33
+ # --in-place,
34
+ # --remove-all-unused-imports,
35
+ # --remove-unused-variables,
36
+ # ]
37
+
38
+ - repo: https://github.com/PyCQA/isort
39
+ rev: 5.12.0
40
+ hooks:
41
+ - id: isort
42
+
43
+ - repo: https://github.com/psf/black
44
+ rev: 23.7.0
45
+ hooks:
46
+ - id: black
47
+ language_version: python3
48
+
49
+ ## If like to embrace black styles even in the docs:
50
+ # - repo: https://github.com/asottile/blacken-docs
51
+ # rev: v1.13.0
52
+ # hooks:
53
+ # - id: blacken-docs
54
+ # additional_dependencies: [black]
55
+
56
+ - repo: https://github.com/PyCQA/flake8
57
+ rev: 6.1.0
58
+ hooks:
59
+ - id: flake8
60
+ ## You can add flake8 plugins via `additional_dependencies`:
61
+ # additional_dependencies: [flake8-bugbear]
62
+
63
+ ## Check for misspells in documentation files:
64
+ # - repo: https://github.com/codespell-project/codespell
65
+ # rev: v2.2.5
66
+ # hooks:
67
+ # - id: codespell
@@ -0,0 +1,371 @@
1
+ ```{todo} THIS IS SUPPOSED TO BE AN EXAMPLE. MODIFY IT ACCORDING TO YOUR NEEDS!
2
+
3
+ The document assumes you are using a source repository service that promotes a
4
+ contribution model similar to [GitHub's fork and pull request workflow].
5
+ While this is true for the majority of services (like GitHub, GitLab,
6
+ BitBucket), it might not be the case for private repositories (e.g., when
7
+ using Gerrit).
8
+
9
+ Also notice that the code examples might refer to GitHub URLs or the text
10
+ might use GitHub specific terminology (e.g., *Pull Request* instead of *Merge
11
+ Request*).
12
+
13
+ Please make sure to check the document having these assumptions in mind
14
+ and update things accordingly.
15
+ ```
16
+
17
+ ```{todo} Provide the correct links/replacements at the bottom of the document.
18
+ ```
19
+
20
+ ```{todo} You might want to have a look on [PyScaffold's contributor's guide],
21
+
22
+ especially if your project is open source. The text should be very similar to
23
+ this template, but there are a few extra contents that you might decide to
24
+ also include, like mentioning labels of your issue tracker or automated
25
+ releases.
26
+ ```
27
+
28
+ # Contributing
29
+
30
+ Welcome to `SingleCellExperiment` contributor's guide.
31
+
32
+ This document focuses on getting any potential contributor familiarized with
33
+ the development processes, but [other kinds of contributions] are also appreciated.
34
+
35
+ If you are new to using [git] or have never collaborated in a project previously,
36
+ please have a look at [contribution-guide.org]. Other resources are also
37
+ listed in the excellent [guide created by FreeCodeCamp] [^contrib1].
38
+
39
+ Please notice, all users and contributors are expected to be **open,
40
+ considerate, reasonable, and respectful**. When in doubt,
41
+ [Python Software Foundation's Code of Conduct] is a good reference in terms of
42
+ behavior guidelines.
43
+
44
+ ## Issue Reports
45
+
46
+ If you experience bugs or general issues with `SingleCellExperiment`, please have a look
47
+ on the [issue tracker].
48
+ If you don't see anything useful there, please feel free to fire an issue report.
49
+
50
+ :::{tip}
51
+ Please don't forget to include the closed issues in your search.
52
+ Sometimes a solution was already reported, and the problem is considered
53
+ **solved**.
54
+ :::
55
+
56
+ New issue reports should include information about your programming environment
57
+ (e.g., operating system, Python version) and steps to reproduce the problem.
58
+ Please try also to simplify the reproduction steps to a very minimal example
59
+ that still illustrates the problem you are facing. By removing other factors,
60
+ you help us to identify the root cause of the issue.
61
+
62
+ ## Documentation Improvements
63
+
64
+ You can help improve `SingleCellExperiment` docs by making them more readable and coherent, or
65
+ by adding missing information and correcting mistakes.
66
+
67
+ `SingleCellExperiment` documentation uses [Sphinx] as its main documentation compiler.
68
+ This means that the docs are kept in the same repository as the project code, and
69
+ that any documentation update is done in the same way was a code contribution.
70
+
71
+ ```{todo} Don't forget to mention which markup language you are using.
72
+
73
+ e.g., [reStructuredText] or [CommonMark] with [MyST] extensions.
74
+ ```
75
+
76
+ ```{todo} If your project is hosted on GitHub, you can also mention the following tip:
77
+
78
+ :::{tip}
79
+ Please notice that the [GitHub web interface] provides a quick way of
80
+ propose changes in `SingleCellExperiment`'s files. While this mechanism can
81
+ be tricky for normal code contributions, it works perfectly fine for
82
+ contributing to the docs, and can be quite handy.
83
+
84
+ If you are interested in trying this method out, please navigate to
85
+ the `docs` folder in the source [repository], find which file you
86
+ would like to propose changes and click in the little pencil icon at the
87
+ top, to open [GitHub's code editor]. Once you finish editing the file,
88
+ please write a message in the form at the bottom of the page describing
89
+ which changes have you made and what are the motivations behind them and
90
+ submit your proposal.
91
+ :::
92
+ ```
93
+
94
+ When working on documentation changes in your local machine, you can
95
+ compile them using [tox] :
96
+
97
+ ```
98
+ tox -e docs
99
+ ```
100
+
101
+ and use Python's built-in web server for a preview in your web browser
102
+ (`http://localhost:8000`):
103
+
104
+ ```
105
+ python3 -m http.server --directory 'docs/_build/html'
106
+ ```
107
+
108
+ ## Code Contributions
109
+
110
+ ```{todo} Please include a reference or explanation about the internals of the project.
111
+
112
+ An architecture description, design principles or at least a summary of the
113
+ main concepts will make it easy for potential contributors to get started
114
+ quickly.
115
+ ```
116
+
117
+ ### Submit an issue
118
+
119
+ Before you work on any non-trivial code contribution it's best to first create
120
+ a report in the [issue tracker] to start a discussion on the subject.
121
+ This often provides additional considerations and avoids unnecessary work.
122
+
123
+ ### Create an environment
124
+
125
+ Before you start coding, we recommend creating an isolated [virtual environment]
126
+ to avoid any problems with your installed Python packages.
127
+ This can easily be done via either [virtualenv]:
128
+
129
+ ```
130
+ virtualenv <PATH TO VENV>
131
+ source <PATH TO VENV>/bin/activate
132
+ ```
133
+
134
+ or [Miniconda]:
135
+
136
+ ```
137
+ conda create -n SingleCellExperiment python=3 six virtualenv pytest pytest-cov
138
+ conda activate SingleCellExperiment
139
+ ```
140
+
141
+ ### Clone the repository
142
+
143
+ 1. Create an user account on GitHub if you do not already have one.
144
+
145
+ 2. Fork the project [repository]: click on the *Fork* button near the top of the
146
+ page. This creates a copy of the code under your account on GitHub.
147
+
148
+ 3. Clone this copy to your local disk:
149
+
150
+ ```
151
+ git clone git@github.com:YourLogin/SingleCellExperiment.git
152
+ cd SingleCellExperiment
153
+ ```
154
+
155
+ 4. You should run:
156
+
157
+ ```
158
+ pip install -U pip setuptools -e .
159
+ ```
160
+
161
+ to be able to import the package under development in the Python REPL.
162
+
163
+ ```{todo} if you are not using pre-commit, please remove the following item:
164
+ ```
165
+
166
+ 5. Install [pre-commit]:
167
+
168
+ ```
169
+ pip install pre-commit
170
+ pre-commit install
171
+ ```
172
+
173
+ `SingleCellExperiment` comes with a lot of hooks configured to automatically help the
174
+ developer to check the code being written.
175
+
176
+ ### Implement your changes
177
+
178
+ 1. Create a branch to hold your changes:
179
+
180
+ ```
181
+ git checkout -b my-feature
182
+ ```
183
+
184
+ and start making changes. Never work on the main branch!
185
+
186
+ 2. Start your work on this branch. Don't forget to add [docstrings] to new
187
+ functions, modules and classes, especially if they are part of public APIs.
188
+
189
+ 3. Add yourself to the list of contributors in `AUTHORS.rst`.
190
+
191
+ 4. When you’re done editing, do:
192
+
193
+ ```
194
+ git add <MODIFIED FILES>
195
+ git commit
196
+ ```
197
+
198
+ to record your changes in [git].
199
+
200
+ ```{todo} if you are not using pre-commit, please remove the following item:
201
+ ```
202
+
203
+ Please make sure to see the validation messages from [pre-commit] and fix
204
+ any eventual issues.
205
+ This should automatically use [flake8]/[black] to check/fix the code style
206
+ in a way that is compatible with the project.
207
+
208
+ :::{important}
209
+ Don't forget to add unit tests and documentation in case your
210
+ contribution adds an additional feature and is not just a bugfix.
211
+
212
+ Moreover, writing a [descriptive commit message] is highly recommended.
213
+ In case of doubt, you can check the commit history with:
214
+
215
+ ```
216
+ git log --graph --decorate --pretty=oneline --abbrev-commit --all
217
+ ```
218
+
219
+ to look for recurring communication patterns.
220
+ :::
221
+
222
+ 5. Please check that your changes don't break any unit tests with:
223
+
224
+ ```
225
+ tox
226
+ ```
227
+
228
+ (after having installed [tox] with `pip install tox` or `pipx`).
229
+
230
+ You can also use [tox] to run several other pre-configured tasks in the
231
+ repository. Try `tox -av` to see a list of the available checks.
232
+
233
+ ### Submit your contribution
234
+
235
+ 1. If everything works fine, push your local branch to the remote server with:
236
+
237
+ ```
238
+ git push -u origin my-feature
239
+ ```
240
+
241
+ 2. Go to the web page of your fork and click "Create pull request"
242
+ to send your changes for review.
243
+
244
+ ```{todo} if you are using GitHub, you can uncomment the following paragraph
245
+
246
+ Find more detailed information in [creating a PR]. You might also want to open
247
+ the PR as a draft first and mark it as ready for review after the feedbacks
248
+ from the continuous integration (CI) system or any required fixes.
249
+
250
+ ```
251
+
252
+ ### Troubleshooting
253
+
254
+ The following tips can be used when facing problems to build or test the
255
+ package:
256
+
257
+ 1. Make sure to fetch all the tags from the upstream [repository].
258
+ The command `git describe --abbrev=0 --tags` should return the version you
259
+ are expecting. If you are trying to run CI scripts in a fork repository,
260
+ make sure to push all the tags.
261
+ You can also try to remove all the egg files or the complete egg folder, i.e.,
262
+ `.eggs`, as well as the `*.egg-info` folders in the `src` folder or
263
+ potentially in the root of your project.
264
+
265
+ 2. Sometimes [tox] misses out when new dependencies are added, especially to
266
+ `setup.cfg` and `docs/requirements.txt`. If you find any problems with
267
+ missing dependencies when running a command with [tox], try to recreate the
268
+ `tox` environment using the `-r` flag. For example, instead of:
269
+
270
+ ```
271
+ tox -e docs
272
+ ```
273
+
274
+ Try running:
275
+
276
+ ```
277
+ tox -r -e docs
278
+ ```
279
+
280
+ 3. Make sure to have a reliable [tox] installation that uses the correct
281
+ Python version (e.g., 3.7+). When in doubt you can run:
282
+
283
+ ```
284
+ tox --version
285
+ # OR
286
+ which tox
287
+ ```
288
+
289
+ If you have trouble and are seeing weird errors upon running [tox], you can
290
+ also try to create a dedicated [virtual environment] with a [tox] binary
291
+ freshly installed. For example:
292
+
293
+ ```
294
+ virtualenv .venv
295
+ source .venv/bin/activate
296
+ .venv/bin/pip install tox
297
+ .venv/bin/tox -e all
298
+ ```
299
+
300
+ 4. [Pytest can drop you] in an interactive session in the case an error occurs.
301
+ In order to do that you need to pass a `--pdb` option (for example by
302
+ running `tox -- -k <NAME OF THE FALLING TEST> --pdb`).
303
+ You can also setup breakpoints manually instead of using the `--pdb` option.
304
+
305
+ ## Maintainer tasks
306
+
307
+ ### Releases
308
+
309
+ ```{todo} This section assumes you are using PyPI to publicly release your package.
310
+
311
+ If instead you are using a different/private package index, please update
312
+ the instructions accordingly.
313
+ ```
314
+
315
+ If you are part of the group of maintainers and have correct user permissions
316
+ on [PyPI], the following steps can be used to release a new version for
317
+ `SingleCellExperiment`:
318
+
319
+ 1. Make sure all unit tests are successful.
320
+ 2. Tag the current commit on the main branch with a release tag, e.g., `v1.2.3`.
321
+ 3. Push the new tag to the upstream [repository],
322
+ e.g., `git push upstream v1.2.3`
323
+ 4. Clean up the `dist` and `build` folders with `tox -e clean`
324
+ (or `rm -rf dist build`)
325
+ to avoid confusion with old builds and Sphinx docs.
326
+ 5. Run `tox -e build` and check that the files in `dist` have
327
+ the correct version (no `.dirty` or [git] hash) according to the [git] tag.
328
+ Also check the sizes of the distributions, if they are too big (e.g., >
329
+ 500KB), unwanted clutter may have been accidentally included.
330
+ 6. Run `tox -e publish -- --repository pypi` and check that everything was
331
+ uploaded to [PyPI] correctly.
332
+
333
+ [^contrib1]: Even though, these resources focus on open source projects and
334
+ communities, the general ideas behind collaborating with other developers
335
+ to collectively create software are general and can be applied to all sorts
336
+ of environments, including private companies and proprietary code bases.
337
+
338
+
339
+ [black]: https://pypi.org/project/black/
340
+ [commonmark]: https://commonmark.org/
341
+ [contribution-guide.org]: http://www.contribution-guide.org/
342
+ [creating a pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
343
+ [descriptive commit message]: https://chris.beams.io/posts/git-commit
344
+ [docstrings]: https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html
345
+ [first-contributions tutorial]: https://github.com/firstcontributions/first-contributions
346
+ [flake8]: https://flake8.pycqa.org/en/stable/
347
+ [git]: https://git-scm.com
348
+ [github web interface]: https://docs.github.com/en/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-your-repository
349
+ [github's code editor]: https://docs.github.com/en/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-your-repository
350
+ [github's fork and pull request workflow]: https://guides.github.com/activities/forking/
351
+ [guide created by freecodecamp]: https://github.com/freecodecamp/how-to-contribute-to-open-source
352
+ [miniconda]: https://docs.conda.io/en/latest/miniconda.html
353
+ [myst]: https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html
354
+ [other kinds of contributions]: https://opensource.guide/how-to-contribute
355
+ [pre-commit]: https://pre-commit.com/
356
+ [pypi]: https://pypi.org/
357
+ [pyscaffold's contributor's guide]: https://pyscaffold.org/en/stable/contributing.html
358
+ [pytest can drop you]: https://docs.pytest.org/en/stable/usage.html#dropping-to-pdb-python-debugger-at-the-start-of-a-test
359
+ [python software foundation's code of conduct]: https://www.python.org/psf/conduct/
360
+ [restructuredtext]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/
361
+ [sphinx]: https://www.sphinx-doc.org/en/master/
362
+ [tox]: https://tox.readthedocs.io/en/stable/
363
+ [virtual environment]: https://realpython.com/python-virtual-environments-a-primer/
364
+ [virtualenv]: https://virtualenv.pypa.io/en/stable/
365
+
366
+
367
+ ```{todo} Please review and change the following definitions:
368
+ ```
369
+
370
+ [repository]: https://github.com/<USERNAME>/SingleCellExperiment
371
+ [issue tracker]: https://github.com/<USERNAME>/SingleCellExperiment/issues
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: SingleCellExperiment
3
- Version: 0.2.5
3
+ Version: 0.3.0
4
4
  Summary: Container class for single-cell experiments
5
5
  Home-page: https://github.com/BiocPy/SingleCellExperiment
6
6
  Author: jkanche
@@ -34,7 +34,7 @@ Readers are available to read AnnData, H5AD or 10x (MTX, H5) V3 formats as `Sing
34
34
  ```python
35
35
  import singlecellexperiment
36
36
 
37
- sce = singlecellexperiment.readH5AD("tests/data/adata.h5ad")
37
+ sce = singlecellexperiment.read_h5ad("tests/data/adata.h5ad")
38
38
  ```
39
39
 
40
40
  ***OR construct one from scratch***
@@ -43,16 +43,16 @@ sce = singlecellexperiment.readH5AD("tests/data/adata.h5ad")
43
43
  from singlecellexperiment import SingleCellExperiment
44
44
 
45
45
  tse = SingleCellExperiment(
46
- assays={"counts": counts}, rowData=df_gr, colData=colData,
47
- reducedDims={"tsne": ..., "umap": ...}, altExps={"atac": ...}
46
+ assays={"counts": counts}, row_data=df_gr, col_data=col_data,
47
+ reduced_dims={"tsne": ..., "umap": ...}, alternative_experiments={"atac": ...}
48
48
  )
49
49
  ```
50
50
 
51
- `SingleCellExperiment` extends `SummarizedExperiment`, so most methods from there are applicable here. checkout the [documentation](https://biocpy.github.io/SingleCellExperiment/).
51
+ Since `SingleCellExperiment` extends `SummarizedExperiment`, most methods especially slicing and accessors are applicable here. Checkout the [documentation](https://biocpy.github.io/SingleCellExperiment/) for more info.
52
52
 
53
53
  <!-- pyscaffold-notes -->
54
54
 
55
55
  ## Note
56
56
 
57
- This project has been set up using PyScaffold 4.1.1. For details and usage
57
+ This project has been set up using PyScaffold 4.5. For details and usage
58
58
  information on PyScaffold see https://pyscaffold.org/.
@@ -18,7 +18,7 @@ Readers are available to read AnnData, H5AD or 10x (MTX, H5) V3 formats as `Sing
18
18
  ```python
19
19
  import singlecellexperiment
20
20
 
21
- sce = singlecellexperiment.readH5AD("tests/data/adata.h5ad")
21
+ sce = singlecellexperiment.read_h5ad("tests/data/adata.h5ad")
22
22
  ```
23
23
 
24
24
  ***OR construct one from scratch***
@@ -27,16 +27,16 @@ sce = singlecellexperiment.readH5AD("tests/data/adata.h5ad")
27
27
  from singlecellexperiment import SingleCellExperiment
28
28
 
29
29
  tse = SingleCellExperiment(
30
- assays={"counts": counts}, rowData=df_gr, colData=colData,
31
- reducedDims={"tsne": ..., "umap": ...}, altExps={"atac": ...}
30
+ assays={"counts": counts}, row_data=df_gr, col_data=col_data,
31
+ reduced_dims={"tsne": ..., "umap": ...}, alternative_experiments={"atac": ...}
32
32
  )
33
33
  ```
34
34
 
35
- `SingleCellExperiment` extends `SummarizedExperiment`, so most methods from there are applicable here. checkout the [documentation](https://biocpy.github.io/SingleCellExperiment/).
35
+ Since `SingleCellExperiment` extends `SummarizedExperiment`, most methods especially slicing and accessors are applicable here. Checkout the [documentation](https://biocpy.github.io/SingleCellExperiment/) for more info.
36
36
 
37
37
  <!-- pyscaffold-notes -->
38
38
 
39
39
  ## Note
40
40
 
41
- This project has been set up using PyScaffold 4.1.1. For details and usage
41
+ This project has been set up using PyScaffold 4.5. For details and usage
42
42
  information on PyScaffold see https://pyscaffold.org/.
@@ -78,25 +78,22 @@ extensions = [
78
78
  templates_path = ["_templates"]
79
79
 
80
80
 
81
- # Configure AutoStructify
82
- # https://recommonmark.readthedocs.io/en/latest/auto_structify.html
83
- def setup(app):
84
- from recommonmark.transform import AutoStructify
85
-
86
- params = {
87
- "enable_auto_toc_tree": True,
88
- "auto_toc_tree_section": "Contents",
89
- "auto_toc_maxdepth": 2,
90
- "enable_eval_rst": True,
91
- "enable_math": True,
92
- "enable_inline_math": True,
93
- }
94
- app.add_config_value("recommonmark_config", params, True)
95
- app.add_transform(AutoStructify)
96
-
97
-
98
81
  # Enable markdown
99
- extensions.append("recommonmark")
82
+ extensions.append("myst_parser")
83
+
84
+ # Configure MyST-Parser
85
+ myst_enable_extensions = [
86
+ "amsmath",
87
+ "colon_fence",
88
+ "deflist",
89
+ "dollarmath",
90
+ "html_image",
91
+ "linkify",
92
+ "replacements",
93
+ "smartquotes",
94
+ "substitution",
95
+ "tasklist",
96
+ ]
100
97
 
101
98
  # The suffix of source filenames.
102
99
  source_suffix = [".rst", ".md"]
@@ -109,7 +106,7 @@ master_doc = "index"
109
106
 
110
107
  # General information about the project.
111
108
  project = "SingleCellExperiment"
112
- copyright = "2022, jkanche"
109
+ copyright = "2023, jkanche"
113
110
 
114
111
  # The version info for the project you're documenting, acts as replacement for
115
112
  # |version| and |release|, also used in various other places throughout the
@@ -169,6 +166,14 @@ pygments_style = "sphinx"
169
166
  # If this is True, todo emits a warning for each TODO entries. The default is False.
170
167
  todo_emit_warnings = True
171
168
 
169
+ autodoc_default_options = {
170
+ 'special-members': True,
171
+ 'undoc-members': False,
172
+ 'exclude-members': '__weakref__, __dict__, __str__, __module__, __init__'
173
+ }
174
+
175
+ autosummary_generate = True
176
+ autosummary_imported_members = True
172
177
 
173
178
  # -- Options for HTML output -------------------------------------------------
174
179
 
@@ -300,8 +305,11 @@ intersphinx_mapping = {
300
305
  "sklearn": ("https://scikit-learn.org/stable", None),
301
306
  "pandas": ("https://pandas.pydata.org/pandas-docs/stable", None),
302
307
  "scipy": ("https://docs.scipy.org/doc/scipy/reference", None),
303
- "setuptools": ("https://setuptools.readthedocs.io/en/stable/", None),
308
+ "setuptools": ("https://setuptools.pypa.io/en/stable/", None),
304
309
  "pyscaffold": ("https://pyscaffold.org/en/stable", None),
310
+ "biocframe": ("https://biocpy.github.io/BiocFrame", None),
311
+ "genomicranges": ("https://biocpy.github.io/GenomicRanges", None),
312
+ "singlecellexperiment": ("https://biocpy.github.io/SingleCellExperiment", None),
305
313
  }
306
314
 
307
315
  print(f"loading configurations for {project} {version} ...", file=sys.stderr)
@@ -0,0 +1,4 @@
1
+ ```{include} ../CONTRIBUTING.md
2
+ :relative-docs: docs/
3
+ :relative-images:
4
+ ```
@@ -12,24 +12,26 @@ pip install singlecellexperiment
12
12
  ```
13
13
  ## Contents
14
14
 
15
- * [Overview](readme)
16
- * [Tutorial](tutorial)
17
- * [License](license)
18
- * [Authors](authors)
19
- * [Changelog](changelog)
20
- * [Module Reference](api/modules)
15
+ ```{toctree}
16
+ :maxdepth: 2
17
+
18
+ Overview <readme>
19
+ Tutorial <tutorial>
20
+ Module Reference <api/modules>
21
+ Contributions & Help <contributing>
22
+ License <license>
23
+ Authors <authors>
24
+ Changelog <changelog>
25
+ ```
21
26
 
22
27
 
23
28
  ## Indices and tables
24
29
 
25
- ```eval_rst
26
- * :ref:`genindex`
27
- * :ref:`modindex`
28
- * :ref:`search`
29
- ```
30
+ - {ref}`genindex`
31
+ - {ref}`modindex`
32
+ - {ref}`search`
30
33
 
31
34
  [Sphinx]: http://www.sphinx-doc.org/
32
35
  [Markdown]: https://daringfireball.net/projects/markdown/
33
36
  [reStructuredText]: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
34
- [recommonmark]: https://recommonmark.readthedocs.io/en/latest
35
- [autostructify]: https://recommonmark.readthedocs.io/en/latest/auto_structify.html
37
+ [MyST]: https://myst-parser.readthedocs.io/en/latest/
@@ -0,0 +1,5 @@
1
+ # License
2
+
3
+ ```{literalinclude} ../LICENSE.txt
4
+ :language: text
5
+ ```
@@ -18,7 +18,7 @@ Readers are available to read AnnData, H5AD or 10x (MTX, H5) V3 formats as `Sing
18
18
  ```python
19
19
  import singlecellexperiment
20
20
 
21
- sce = singlecellexperiment.readH5AD("tests/data/adata.h5ad")
21
+ sce = singlecellexperiment.read_h5ad("tests/data/adata.h5ad")
22
22
  ```
23
23
 
24
24
  ***OR construct one from scratch***
@@ -27,16 +27,16 @@ sce = singlecellexperiment.readH5AD("tests/data/adata.h5ad")
27
27
  from singlecellexperiment import SingleCellExperiment
28
28
 
29
29
  tse = SingleCellExperiment(
30
- assays={"counts": counts}, rowData=df_gr, colData=colData,
31
- reducedDims={"tsne": ..., "umap": ...}, altExps={"atac": ...}
30
+ assays={"counts": counts}, row_data=df_gr, col_data=col_data,
31
+ reduced_dims={"tsne": ..., "umap": ...}, alternative_experiments={"atac": ...}
32
32
  )
33
33
  ```
34
34
 
35
- `SingleCellExperiment` extends `SummarizedExperiment`, so most methods from there are applicable here. checkout the [documentation](https://biocpy.github.io/SingleCellExperiment/).
35
+ Since `SingleCellExperiment` extends `SummarizedExperiment`, most methods especially slicing and accessors are applicable here. Checkout the [documentation](https://biocpy.github.io/SingleCellExperiment/) for more info.
36
36
 
37
37
  <!-- pyscaffold-notes -->
38
38
 
39
39
  ## Note
40
40
 
41
- This project has been set up using PyScaffold 4.1.1. For details and usage
41
+ This project has been set up using PyScaffold 4.5. For details and usage
42
42
  information on PyScaffold see https://pyscaffold.org/.
@@ -2,7 +2,6 @@
2
2
  # To build the module reference correctly, make sure every external package
3
3
  # under `install_requires` in `setup.cfg` is also listed here!
4
4
  # sphinx_rtd_theme
5
- recommonmark
5
+ myst-parser[linkify]
6
6
  sphinx>=3.2.1
7
- sphinx-rtd-theme
8
7
  furo