rectanglepy 0.0.39__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 (39) hide show
  1. rectanglepy-0.0.39/.bumpversion.cfg +8 -0
  2. rectanglepy-0.0.39/.cruft.json +23 -0
  3. rectanglepy-0.0.39/.editorconfig +12 -0
  4. rectanglepy-0.0.39/.github/ISSUE_TEMPLATE/bug_report.yml +89 -0
  5. rectanglepy-0.0.39/.github/ISSUE_TEMPLATE/config.yml +5 -0
  6. rectanglepy-0.0.39/.github/ISSUE_TEMPLATE/feature_request.yml +11 -0
  7. rectanglepy-0.0.39/.github/PULL_REQUEST_TEMPLATE.md +14 -0
  8. rectanglepy-0.0.39/.github/workflows/build.yaml +67 -0
  9. rectanglepy-0.0.39/.github/workflows/release.yaml +85 -0
  10. rectanglepy-0.0.39/.github/workflows/test.yaml +50 -0
  11. rectanglepy-0.0.39/.gitignore +28 -0
  12. rectanglepy-0.0.39/.pre-commit-config.yaml +50 -0
  13. rectanglepy-0.0.39/.readthedocs.yaml +17 -0
  14. rectanglepy-0.0.39/CHANGELOG.md +15 -0
  15. rectanglepy-0.0.39/LICENSE +21 -0
  16. rectanglepy-0.0.39/PKG-INFO +104 -0
  17. rectanglepy-0.0.39/README.md +52 -0
  18. rectanglepy-0.0.39/pyproject.toml +126 -0
  19. rectanglepy-0.0.39/src/rectanglepy/__init__.py +8 -0
  20. rectanglepy-0.0.39/src/rectanglepy/data/hao1_annotations_small.csv +96 -0
  21. rectanglepy-0.0.39/src/rectanglepy/data/hao1_counts_small.csv +6934 -0
  22. rectanglepy-0.0.39/src/rectanglepy/data/small_fino_bulks.csv +3739 -0
  23. rectanglepy-0.0.39/src/rectanglepy/pp/__init__.py +4 -0
  24. rectanglepy-0.0.39/src/rectanglepy/pp/create_signature.py +456 -0
  25. rectanglepy-0.0.39/src/rectanglepy/pp/rectangle_signature.py +80 -0
  26. rectanglepy-0.0.39/src/rectanglepy/rectangle.py +117 -0
  27. rectanglepy-0.0.39/src/rectanglepy/tl/__init__.py +3 -0
  28. rectanglepy-0.0.39/src/rectanglepy/tl/deconvolution.py +333 -0
  29. rectanglepy-0.0.39/tests/data/TIL10_signature.txt +171 -0
  30. rectanglepy-0.0.39/tests/data/bulk_small.csv +1001 -0
  31. rectanglepy-0.0.39/tests/data/cell_annotations_small.txt +100 -0
  32. rectanglepy-0.0.39/tests/data/quanTIseq_SimRNAseq_mixture_smaller.csv +19374 -0
  33. rectanglepy-0.0.39/tests/data/quanTIseq_SimRNAseq_read_fractions_small.txt +21 -0
  34. rectanglepy-0.0.39/tests/data/sc_object_small.csv +1001 -0
  35. rectanglepy-0.0.39/tests/data/signature_hao1.csv +2112 -0
  36. rectanglepy-0.0.39/tests/run2.py +800 -0
  37. rectanglepy-0.0.39/tests/test_pp.py +243 -0
  38. rectanglepy-0.0.39/tests/test_rectangle.py +34 -0
  39. rectanglepy-0.0.39/tests/test_tl.py +131 -0
@@ -0,0 +1,8 @@
1
+ [bumpversion]
2
+ current_version = 0.0.39
3
+ tag = True
4
+ commit = True
5
+
6
+ [bumpversion:file:./pyproject.toml]
7
+ search = version = "{current_version}"
8
+ replace = version = "{new_version}"
@@ -0,0 +1,23 @@
1
+ {
2
+ "template": "https://github.com/scverse/cookiecutter-scverse",
3
+ "commit": "57f6267716826dad73baba46dc3c00fe7262c459",
4
+ "checkout": null,
5
+ "context": {
6
+ "cookiecutter": {
7
+ "project_name": "Rectangle",
8
+ "package_name": "rectanglepy",
9
+ "project_description": "A very interesting piece of code",
10
+ "author_full_name": "Bernhard Eder",
11
+ "author_email": "yourname@example.com",
12
+ "github_user": "bernheder",
13
+ "project_repo": "https://github.com/bernheder/Rectangle",
14
+ "license": "MIT License",
15
+ "_copy_without_render": [
16
+ ".github/workflows/**.yaml",
17
+ "docs/_templates/autosummary/**.rst"
18
+ ],
19
+ "_template": "https://github.com/scverse/cookiecutter-scverse"
20
+ }
21
+ },
22
+ "directory": null
23
+ }
@@ -0,0 +1,12 @@
1
+ root = true
2
+
3
+ [*]
4
+ indent_style = space
5
+ indent_size = 4
6
+ end_of_line = lf
7
+ charset = utf-8
8
+ trim_trailing_whitespace = true
9
+ insert_final_newline = true
10
+
11
+ [Makefile]
12
+ indent_style = tab
@@ -0,0 +1,89 @@
1
+ name: Bug report
2
+ description: Report something that is broken or incorrect
3
+ labels: bug
4
+ body:
5
+ - type: markdown
6
+ attributes:
7
+ value: |
8
+ **Note**: Please read [this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
9
+ detailing how to provide the necessary information for us to reproduce your bug. In brief:
10
+ * Please provide exact steps how to reproduce the bug in a clean Python environment.
11
+ * In case it's not clear what's causing this bug, please provide the data or the data generation procedure.
12
+ * Sometimes it is not possible to share the data, but usually it is possible to replicate problems on publicly
13
+ available datasets or to share a subset of your data.
14
+
15
+ - type: textarea
16
+ id: report
17
+ attributes:
18
+ label: Report
19
+ description: A clear and concise description of what the bug is.
20
+ validations:
21
+ required: true
22
+
23
+ - type: textarea
24
+ id: versions
25
+ attributes:
26
+ label: Version information
27
+ description: |
28
+ Please paste below the output of
29
+
30
+ ```python
31
+ import session_info
32
+ session_info.show(html=False, dependencies=True)
33
+ ```
34
+ placeholder: |
35
+ -----
36
+ anndata 0.8.0rc2.dev27+ge524389
37
+ session_info 1.0.0
38
+ -----
39
+ asttokens NA
40
+ awkward 1.8.0
41
+ backcall 0.2.0
42
+ cython_runtime NA
43
+ dateutil 2.8.2
44
+ debugpy 1.6.0
45
+ decorator 5.1.1
46
+ entrypoints 0.4
47
+ executing 0.8.3
48
+ h5py 3.7.0
49
+ ipykernel 6.15.0
50
+ jedi 0.18.1
51
+ mpl_toolkits NA
52
+ natsort 8.1.0
53
+ numpy 1.22.4
54
+ packaging 21.3
55
+ pandas 1.4.2
56
+ parso 0.8.3
57
+ pexpect 4.8.0
58
+ pickleshare 0.7.5
59
+ pkg_resources NA
60
+ prompt_toolkit 3.0.29
61
+ psutil 5.9.1
62
+ ptyprocess 0.7.0
63
+ pure_eval 0.2.2
64
+ pydev_ipython NA
65
+ pydevconsole NA
66
+ pydevd 2.8.0
67
+ pydevd_file_utils NA
68
+ pydevd_plugins NA
69
+ pydevd_tracing NA
70
+ pygments 2.12.0
71
+ pytz 2022.1
72
+ scipy 1.8.1
73
+ setuptools 62.5.0
74
+ setuptools_scm NA
75
+ six 1.16.0
76
+ stack_data 0.3.0
77
+ tornado 6.1
78
+ traitlets 5.3.0
79
+ wcwidth 0.2.5
80
+ zmq 23.1.0
81
+ -----
82
+ IPython 8.4.0
83
+ jupyter_client 7.3.4
84
+ jupyter_core 4.10.0
85
+ -----
86
+ Python 3.9.13 | packaged by conda-forge | (main, May 27 2022, 16:58:50) [GCC 10.3.0]
87
+ Linux-5.18.6-arch1-1-x86_64-with-glibc2.35
88
+ -----
89
+ Session information updated at 2022-07-07 17:55
@@ -0,0 +1,5 @@
1
+ blank_issues_enabled: false
2
+ contact_links:
3
+ - name: Scverse Community Forum
4
+ url: https://discourse.scverse.org/
5
+ about: If you have questions about “How to do X”, please ask them here.
@@ -0,0 +1,11 @@
1
+ name: Feature request
2
+ description: Propose a new feature for Rectangle
3
+ labels: enhancement
4
+ body:
5
+ - type: textarea
6
+ id: description
7
+ attributes:
8
+ label: Description of feature
9
+ description: Please describe your suggestion for a new feature. It might help to describe a problem or use case, plus any alternatives that you have considered.
10
+ validations:
11
+ required: true
@@ -0,0 +1,14 @@
1
+ ### Description
2
+
3
+ Please explain the changes you made here.
4
+
5
+ ### Associated Task
6
+
7
+ Please list closed, fixed, or resolved issues here with a # and the number.
8
+
9
+ ### Checklist
10
+
11
+ - [ ] Code builds correctly
12
+ - [ ] Added tests that fail without the change (if possible)
13
+ - [ ] All tests passing
14
+ - [ ] Extended the documentation
@@ -0,0 +1,67 @@
1
+ name: CI Checks
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+ branches: [main]
8
+
9
+ concurrency:
10
+ group: ${{ github.workflow }}-${{ github.ref }}
11
+ cancel-in-progress: true
12
+
13
+ jobs:
14
+ test:
15
+ runs-on: ${{ matrix.os }}
16
+ defaults:
17
+ run:
18
+ shell: bash -e {0} # -e to fail on error
19
+
20
+ strategy:
21
+ fail-fast: false
22
+ matrix:
23
+ include:
24
+ - os: ubuntu-latest
25
+ python: "3.10"
26
+ env:
27
+ OS: ${{ matrix.os }}
28
+ PYTHON: ${{ matrix.python }}
29
+
30
+ steps:
31
+ - uses: actions/checkout@v3
32
+ - name: Set up Python ${{ matrix.python }}
33
+ uses: actions/setup-python@v4
34
+ with:
35
+ python-version: ${{ matrix.python }}
36
+ cache: "pip"
37
+ cache-dependency-path: "**/pyproject.toml"
38
+
39
+ - name: Install test dependencies
40
+ run: |
41
+ python -m pip install --upgrade pip wheel
42
+ - name: Install dependencies
43
+ run: |
44
+ pip install ${{ matrix.pip-flags }} ".[dev,test]"
45
+ - name: Test
46
+ env:
47
+ MPLBACKEND: agg
48
+ PLATFORM: ${{ matrix.os }}
49
+ DISPLAY: :42
50
+ run: |
51
+ pytest -v --color=yes
52
+
53
+ package:
54
+ runs-on: ubuntu-latest
55
+ needs: test
56
+ steps:
57
+ - uses: actions/checkout@v2
58
+ - name: Set up Python 3.10
59
+ uses: actions/setup-python@v2
60
+ with:
61
+ python-version: "3.10"
62
+ - name: Install build dependencies
63
+ run: python -m pip install --upgrade pip wheel twine build
64
+ - name: Build package
65
+ run: python -m build
66
+ - name: Check package
67
+ run: twine check --strict dist/*.whl
@@ -0,0 +1,85 @@
1
+ name: Release
2
+
3
+ on:
4
+ push:
5
+ tags:
6
+ - "*.*.*"
7
+
8
+ jobs:
9
+ test:
10
+ runs-on: ${{ matrix.os }}
11
+ defaults:
12
+ run:
13
+ shell: bash -e {0} # -e to fail on error
14
+
15
+ strategy:
16
+ fail-fast: false
17
+ matrix:
18
+ include:
19
+ - os: ubuntu-latest
20
+ python: "3.10"
21
+ env:
22
+ OS: ${{ matrix.os }}
23
+ PYTHON: ${{ matrix.python }}
24
+
25
+ steps:
26
+ - uses: actions/checkout@v3
27
+ - name: Set up Python ${{ matrix.python }}
28
+ uses: actions/setup-python@v4
29
+ with:
30
+ python-version: ${{ matrix.python }}
31
+ cache: "pip"
32
+ cache-dependency-path: "**/pyproject.toml"
33
+
34
+ - name: Install test dependencies
35
+ run: |
36
+ python -m pip install --upgrade pip wheel
37
+ - name: Install dependencies
38
+ run: |
39
+ pip install ${{ matrix.pip-flags }} ".[dev,test]"
40
+ - name: Test
41
+ env:
42
+ MPLBACKEND: agg
43
+ PLATFORM: ${{ matrix.os }}
44
+ DISPLAY: :42
45
+ run: |
46
+ pytest -v --color=yes
47
+ package:
48
+ runs-on: ubuntu-latest
49
+ needs: test
50
+ steps:
51
+ - uses: actions/checkout@v2
52
+ - name: Set up Python 3.10
53
+ uses: actions/setup-python@v2
54
+ with:
55
+ python-version: "3.10"
56
+ - name: Install build dependencies
57
+ run: python -m pip install --upgrade pip wheel twine build
58
+ - name: Build package
59
+ run: python -m build
60
+ - name: Check package
61
+ run: twine check --strict dist/*.whl
62
+
63
+ release:
64
+ name: Release
65
+ needs: test
66
+ runs-on: ubuntu-latest
67
+ steps:
68
+ - name: Checkout code
69
+ uses: actions/checkout@v3
70
+
71
+ - name: Set up Python 3.10
72
+ uses: actions/setup-python@v4
73
+ with:
74
+ python-version: "3.10"
75
+
76
+ - name: Install hatch
77
+ run: pip install hatch
78
+
79
+ - name: Build project for distribution
80
+ run: hatch build
81
+
82
+ - name: Publish a Python distribution to PyPI
83
+ uses: pypa/gh-action-pypi-publish@release/v1
84
+ with:
85
+ password: ${{ secrets.PYPI_API_TOKEN }}
@@ -0,0 +1,50 @@
1
+ name: CI Checks
2
+
3
+ on:
4
+ push:
5
+ branches-ignore:
6
+ - main
7
+
8
+ concurrency:
9
+ group: ${{ github.workflow }}-${{ github.ref }}
10
+ cancel-in-progress: true
11
+
12
+ jobs:
13
+ test:
14
+ runs-on: ${{ matrix.os }}
15
+ defaults:
16
+ run:
17
+ shell: bash -e {0} # -e to fail on error
18
+
19
+ strategy:
20
+ fail-fast: false
21
+ matrix:
22
+ include:
23
+ - os: ubuntu-latest
24
+ python: "3.10"
25
+ env:
26
+ OS: ${{ matrix.os }}
27
+ PYTHON: ${{ matrix.python }}
28
+
29
+ steps:
30
+ - uses: actions/checkout@v3
31
+ - name: Set up Python ${{ matrix.python }}
32
+ uses: actions/setup-python@v4
33
+ with:
34
+ python-version: ${{ matrix.python }}
35
+ cache: "pip"
36
+ cache-dependency-path: "**/pyproject.toml"
37
+
38
+ - name: Install test dependencies
39
+ run: |
40
+ python -m pip install --upgrade pip wheel
41
+ - name: Install dependencies
42
+ run: |
43
+ pip install ${{ matrix.pip-flags }} ".[dev,test]"
44
+ - name: Test
45
+ env:
46
+ MPLBACKEND: agg
47
+ PLATFORM: ${{ matrix.os }}
48
+ DISPLAY: :42
49
+ run: |
50
+ pytest -v --color=yes
@@ -0,0 +1,28 @@
1
+ # Temp files
2
+ .DS_Store
3
+ *~
4
+ buck-out/
5
+
6
+ # Compiled files
7
+ .venv/
8
+ __pycache__/
9
+ .mypy_cache/
10
+ .ruff_cache/
11
+
12
+ # Distribution / packaging
13
+ /build/
14
+ /dist/
15
+ /*.egg-info/
16
+
17
+ # Tests and coverage
18
+ /.pytest_cache/
19
+ /.cache/
20
+ /data/
21
+
22
+ # docs
23
+ /docs/generated/
24
+ /docs/_build/
25
+
26
+ # IDEs
27
+ /.idea/
28
+ /.vscode/
@@ -0,0 +1,50 @@
1
+ fail_fast: false
2
+ default_language_version:
3
+ python: python3
4
+ default_stages:
5
+ - commit
6
+ - push
7
+ minimum_pre_commit_version: 2.16.0
8
+ repos:
9
+ - repo: https://github.com/psf/black
10
+ rev: "23.1.0"
11
+ hooks:
12
+ - id: black
13
+ - repo: https://github.com/asottile/blacken-docs
14
+ rev: 1.13.0
15
+ hooks:
16
+ - id: blacken-docs
17
+ - repo: https://github.com/pre-commit/mirrors-prettier
18
+ rev: v3.0.0-alpha.6
19
+ hooks:
20
+ - id: prettier
21
+ # Newer versions of node don't work on systems that have an older version of GLIBC
22
+ # (in particular Ubuntu 18.04 and Centos 7)
23
+ # EOL of Centos 7 is in 2024-06, we can probably get rid of this then.
24
+ # See https://github.com/scverse/cookiecutter-scverse/issues/143 and
25
+ # https://github.com/jupyterlab/jupyterlab/issues/12675
26
+ language_version: "17.9.1"
27
+ - repo: https://github.com/charliermarsh/ruff-pre-commit
28
+ rev: v0.0.256
29
+ hooks:
30
+ - id: ruff
31
+ args: [--fix, --exit-non-zero-on-fix]
32
+ - repo: https://github.com/pre-commit/pre-commit-hooks
33
+ rev: v4.4.0
34
+ hooks:
35
+ - id: detect-private-key
36
+ - id: check-ast
37
+ - id: end-of-file-fixer
38
+ - id: mixed-line-ending
39
+ args: [--fix=lf]
40
+ - id: trailing-whitespace
41
+ - id: check-case-conflict
42
+ - repo: local
43
+ hooks:
44
+ - id: forbid-to-commit
45
+ name: Don't commit rej files
46
+ entry: |
47
+ Cannot commit .rej files. These indicate merge conflicts that arise during automated template updates.
48
+ Fix the merge conflicts manually and remove the .rej files.
49
+ language: fail
50
+ files: '.*\.rej$'
@@ -0,0 +1,17 @@
1
+ # https://docs.readthedocs.io/en/stable/config-file/v2.html
2
+ version: 2
3
+ build:
4
+ os: ubuntu-20.04
5
+ apt_packages:
6
+ - r-base
7
+ tools:
8
+ python: "3.10"
9
+ sphinx:
10
+ configuration: docs/conf.py
11
+ fail_on_warning: false
12
+ python:
13
+ install:
14
+ - method: pip
15
+ path: .
16
+ extra_requirements:
17
+ - doc
@@ -0,0 +1,15 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog][],
6
+ and this project adheres to [Semantic Versioning][].
7
+
8
+ [keep a changelog]: https://keepachangelog.com/en/1.0.0/
9
+ [semantic versioning]: https://semver.org/spec/v2.0.0.html
10
+
11
+ ## [Unreleased]
12
+
13
+ ### Added
14
+
15
+ - Basic tool, preprocessing and plotting functions
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2023, Bernhard Eder
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,104 @@
1
+ Metadata-Version: 2.1
2
+ Name: rectanglepy
3
+ Version: 0.0.39
4
+ Summary: A very interesting piece of code
5
+ Project-URL: Documentation, https://rectanglepy.readthedocs.io/
6
+ Project-URL: Source, https://github.com/bernheder/Rectangle
7
+ Project-URL: Home-page, https://github.com/bernheder/Rectangle
8
+ Author: Bernhard Eder
9
+ Maintainer-email: Bernhard Eder <Bernhard.Eder@student.uibk.ac.at>
10
+ License: MIT License
11
+
12
+ Copyright (c) 2023, Bernhard Eder
13
+
14
+ Permission is hereby granted, free of charge, to any person obtaining a copy
15
+ of this software and associated documentation files (the "Software"), to deal
16
+ in the Software without restriction, including without limitation the rights
17
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18
+ copies of the Software, and to permit persons to whom the Software is
19
+ furnished to do so, subject to the following conditions:
20
+
21
+ The above copyright notice and this permission notice shall be included in all
22
+ copies or substantial portions of the Software.
23
+
24
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
27
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
29
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30
+ SOFTWARE.
31
+ License-File: LICENSE
32
+ Requires-Python: >=3.10
33
+ Requires-Dist: loguru
34
+ Requires-Dist: pydeseq2==0.4.1
35
+ Requires-Dist: quadprog==0.1.11
36
+ Provides-Extra: dev
37
+ Requires-Dist: bump2version; extra == 'dev'
38
+ Requires-Dist: pre-commit; extra == 'dev'
39
+ Requires-Dist: twine>=4.0.2; extra == 'dev'
40
+ Provides-Extra: doc
41
+ Requires-Dist: ipykernel; extra == 'doc'
42
+ Requires-Dist: ipython; extra == 'doc'
43
+ Requires-Dist: myst-nb; extra == 'doc'
44
+ Requires-Dist: sphinx-autodoc-typehints; extra == 'doc'
45
+ Requires-Dist: sphinx-book-theme>=1.0.0; extra == 'doc'
46
+ Requires-Dist: sphinx-copybutton; extra == 'doc'
47
+ Requires-Dist: sphinx>=4; extra == 'doc'
48
+ Requires-Dist: sphinxcontrib-bibtex>=1.0.0; extra == 'doc'
49
+ Provides-Extra: test
50
+ Requires-Dist: pytest; extra == 'test'
51
+ Description-Content-Type: text/markdown
52
+
53
+ # Rectangle
54
+
55
+ [![Tests][badge-tests]][link-tests]
56
+ [![Documentation][badge-docs]][link-docs]
57
+
58
+ [badge-tests]: https://img.shields.io/github/actions/workflow/status/bernheder/Rectangle/test.yaml?branch=main
59
+ [link-tests]: https://github.com/bernheder/Rectangle/actions/workflows/test.yml
60
+ [badge-docs]: https://img.shields.io/readthedocs/Rectangle
61
+
62
+ Rectangle embodies a ”second-generation” deconvolution methodology, setting itself apart from other second-generation
63
+ methods through its efficiency in signature creation and its handling of challenges within the deconvolution process.
64
+ To establish a precise deconvolution method, we employ a hierarchical analysis approach, incorporate mRNA bias
65
+ correction, and provide an estimation of unknown cellular content.
66
+
67
+ ## Getting started
68
+
69
+ Please refer to the [documentation][link-docs]. In particular, the
70
+
71
+ - [API documentation][link-api].
72
+
73
+ ## Installation
74
+
75
+ You need to have Python 3.10 or newer installed on your system. If you don't have
76
+ Python installed, we recommend installing [Mambaforge](https://github.com/conda-forge/miniforge#mambaforge).
77
+
78
+ How to install Rectangle:
79
+
80
+ <!--
81
+ 1) Install the latest release of `Rectangle` from `PyPI <https://pypi.org/project/rectanglepy/>`_:
82
+
83
+ ```bash
84
+ pip install rectanglepy
85
+ ```
86
+ -->
87
+
88
+ ## Release notes
89
+
90
+ See the [changelog][changelog].
91
+
92
+ ## Contact
93
+
94
+ If you found a bug, please use the [issue tracker][issue-tracker].
95
+
96
+ ## Citation
97
+
98
+ > t.b.a
99
+
100
+ [scverse-discourse]: https://discourse.scverse.org/
101
+ [issue-tracker]: https://github.com/bernheder/Rectangle/issues
102
+ [changelog]: https://Rectanglepy.readthedocs.io/latest/changelog.html
103
+ [link-docs]: https://Rectanglepy.readthedocs.io
104
+ [link-api]: https://Rectanglepy.readthedocs.io/latest/api.html
@@ -0,0 +1,52 @@
1
+ # Rectangle
2
+
3
+ [![Tests][badge-tests]][link-tests]
4
+ [![Documentation][badge-docs]][link-docs]
5
+
6
+ [badge-tests]: https://img.shields.io/github/actions/workflow/status/bernheder/Rectangle/test.yaml?branch=main
7
+ [link-tests]: https://github.com/bernheder/Rectangle/actions/workflows/test.yml
8
+ [badge-docs]: https://img.shields.io/readthedocs/Rectangle
9
+
10
+ Rectangle embodies a ”second-generation” deconvolution methodology, setting itself apart from other second-generation
11
+ methods through its efficiency in signature creation and its handling of challenges within the deconvolution process.
12
+ To establish a precise deconvolution method, we employ a hierarchical analysis approach, incorporate mRNA bias
13
+ correction, and provide an estimation of unknown cellular content.
14
+
15
+ ## Getting started
16
+
17
+ Please refer to the [documentation][link-docs]. In particular, the
18
+
19
+ - [API documentation][link-api].
20
+
21
+ ## Installation
22
+
23
+ You need to have Python 3.10 or newer installed on your system. If you don't have
24
+ Python installed, we recommend installing [Mambaforge](https://github.com/conda-forge/miniforge#mambaforge).
25
+
26
+ How to install Rectangle:
27
+
28
+ <!--
29
+ 1) Install the latest release of `Rectangle` from `PyPI <https://pypi.org/project/rectanglepy/>`_:
30
+
31
+ ```bash
32
+ pip install rectanglepy
33
+ ```
34
+ -->
35
+
36
+ ## Release notes
37
+
38
+ See the [changelog][changelog].
39
+
40
+ ## Contact
41
+
42
+ If you found a bug, please use the [issue tracker][issue-tracker].
43
+
44
+ ## Citation
45
+
46
+ > t.b.a
47
+
48
+ [scverse-discourse]: https://discourse.scverse.org/
49
+ [issue-tracker]: https://github.com/bernheder/Rectangle/issues
50
+ [changelog]: https://Rectanglepy.readthedocs.io/latest/changelog.html
51
+ [link-docs]: https://Rectanglepy.readthedocs.io
52
+ [link-api]: https://Rectanglepy.readthedocs.io/latest/api.html