majec 0.1.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.
- majec-0.1.0/LICENSE +191 -0
- majec-0.1.0/PKG-INFO +171 -0
- majec-0.1.0/README.md +135 -0
- majec-0.1.0/pyproject.toml +63 -0
- majec-0.1.0/src/majec/__init__.py +1 -0
- majec-0.1.0/src/majec/analysis/__init__.py +0 -0
- majec-0.1.0/src/majec/analysis/deseq2.py +1156 -0
- majec-0.1.0/src/majec/analysis/visualization.py +4489 -0
- majec-0.1.0/src/majec/database.py +1537 -0
- majec-0.1.0/src/majec/pipeline.py +3320 -0
- majec-0.1.0/src/majec/preprocess.py +1695 -0
- majec-0.1.0/src/majec/tools/__init__.py +0 -0
- majec-0.1.0/src/majec/tools/fragment_lengths.py +250 -0
- majec-0.1.0/src/majec/tools/normalization.py +118 -0
- majec-0.1.0/src/majec/tools/thresholds.py +226 -0
- majec-0.1.0/src/majec/utils/__init__.py +0 -0
- majec-0.1.0/src/majec/utils/cache.py +193 -0
- majec-0.1.0/src/majec/utils/confidence_utils.py +1541 -0
- majec-0.1.0/src/majec/utils/group_confidence.py +655 -0
- majec-0.1.0/src/majec/utils/junctions.py +1604 -0
- majec-0.1.0/src/majec/utils/pipeline_utils.py +442 -0
majec-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to the Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by the Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding any notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
Copyright 2026 Ari J. Firestone
|
|
180
|
+
|
|
181
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
182
|
+
you may not use this file except in compliance with the License.
|
|
183
|
+
You may obtain a copy of the License at
|
|
184
|
+
|
|
185
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
186
|
+
|
|
187
|
+
Unless required by applicable law or agreed to in writing, software
|
|
188
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
189
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
190
|
+
See the License for the specific language governing permissions and
|
|
191
|
+
limitations under the License.
|
majec-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,171 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: majec
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Momentum-Accelerated Junction-Enhanced Counting Ecosystem
|
|
5
|
+
License: Apache-2.0
|
|
6
|
+
License-File: LICENSE
|
|
7
|
+
Author: Ari J. Firestone
|
|
8
|
+
Author-email: arijfire@alumni.stanford.edu
|
|
9
|
+
Requires-Python: >=3.11,<4.0
|
|
10
|
+
Classifier: Intended Audience :: Science/Research
|
|
11
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
12
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
18
|
+
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
|
|
19
|
+
Provides-Extra: database
|
|
20
|
+
Provides-Extra: dev
|
|
21
|
+
Provides-Extra: full-analysis
|
|
22
|
+
Provides-Extra: tools
|
|
23
|
+
Provides-Extra: viz
|
|
24
|
+
Requires-Dist: intervaltree (>=3.1,<4.0) ; extra == "full-analysis"
|
|
25
|
+
Requires-Dist: numpy (>=2.3,<3.0)
|
|
26
|
+
Requires-Dist: pandas (>=2.3,<3.0)
|
|
27
|
+
Requires-Dist: plotly (>=6.3) ; extra == "viz" or extra == "full-analysis"
|
|
28
|
+
Requires-Dist: polars (>=1.33) ; extra == "database" or extra == "full-analysis"
|
|
29
|
+
Requires-Dist: pypdf2 (>=3.0) ; extra == "viz" or extra == "full-analysis"
|
|
30
|
+
Requires-Dist: pytest (>=8.0,<9.0) ; extra == "dev"
|
|
31
|
+
Requires-Dist: python-kaleido (>=1.0) ; extra == "viz" or extra == "full-analysis"
|
|
32
|
+
Requires-Dist: scipy (>=1.16) ; extra == "tools" or extra == "full-analysis"
|
|
33
|
+
Requires-Dist: xlsxwriter (>=3.1) ; extra == "viz"
|
|
34
|
+
Description-Content-Type: text/markdown
|
|
35
|
+
|
|
36
|
+
# MAJEC
|
|
37
|
+
|
|
38
|
+
<img width="2816" height="1536" alt="Gemini_Generated_Image_7e14am7e14am7e14" src="https://github.com/user-attachments/assets/c3a50e27-7bf0-45b5-9e23-8aa55d3551a3" />
|
|
39
|
+
|
|
40
|
+
**Momentum-Accelerated Junction-Enhanced Counting** — unified gene, isoform, and locus-level transposable element quantification from RNA-seq.
|
|
41
|
+
|
|
42
|
+
MAJEC jointly quantifies genes, transcript isoforms, and individual TE loci from standard BAM alignments in a single pass. By operating a probabilistically resolved Expectation-Maximization (EM) algorithm on a **joint gene+TE feature space**, MAJEC eliminates the systematic signal misattribution that plagues existing TE quantification tools.
|
|
43
|
+
|
|
44
|
+
## The Gene-TE Overlap Problem
|
|
45
|
+
|
|
46
|
+
Approximately 45% of the human genome consists of TEs, many of which are embedded directly within gene bodies.
|
|
47
|
+
|
|
48
|
+
* **TE-only tools:** Operate blind to genes. When a host gene is transcribed, its reads are falsely attributed to the overlapping TE, driving massive false-positive TE reactivation calls.
|
|
49
|
+
|
|
50
|
+
**The MAJEC Solution:** Genes and TEs compete for reads probabilistically. MAJEC uses empirical splice junction evidence to heavily penalize unsupported transcript isoforms, preventing them from stealing genuine TE reads, while correctly assigning spliced genic reads to their host genes.
|
|
51
|
+
|
|
52
|
+
## Key Features
|
|
53
|
+
|
|
54
|
+
- **Joint gene+TE feature space**: genes and TE loci compete for reads probabilistically, preventing systematic misattribution at overlapping loci
|
|
55
|
+
- **Junction-informed priors**: splice junction evidence from the BAM drives isoform-level accuracy and helps distinguish genic from TE-derived signal
|
|
56
|
+
- **Locus-level TE resolution**: individual TE insertions are quantified — not just subfamily aggregates
|
|
57
|
+
- **Confidence metrics**: per-transcript distinguishability scores, assignment entropy, and discord scores for transparent quality assessment
|
|
58
|
+
- **Fast**: momentum-accelerated EM typically converges in ~15 iterations; multiprocessing across samples
|
|
59
|
+
|
|
60
|
+
## Installation
|
|
61
|
+
|
|
62
|
+
### From source
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
mamba env create -f majec.yml
|
|
66
|
+
conda activate majec
|
|
67
|
+
pip install -e .
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Dependencies
|
|
71
|
+
|
|
72
|
+
Installed automatically via the conda environment:
|
|
73
|
+
|
|
74
|
+
- [Subread](http://subread.sourceforge.net/) (featureCounts) >= 2.0
|
|
75
|
+
- [samtools](http://www.htslib.org/) >= 1.20
|
|
76
|
+
- [bedtools](https://bedtools.readthedocs.io/) >= 2.31
|
|
77
|
+
|
|
78
|
+
## Quick Start
|
|
79
|
+
|
|
80
|
+
### 1. Precompute Annotations
|
|
81
|
+
|
|
82
|
+
Combine your gene and TE GTFs into a unified, mathematically optimized index.
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
majec_precompute_annotations \
|
|
86
|
+
--gene_gtf gencode.v44.annotation.gtf \
|
|
87
|
+
--te_gtf hg38_rmsk_TE.gtf \
|
|
88
|
+
--output my_annotations
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
This produces `my_annotations_annotations.pkl.gz` (and optionally `_subset_coverage_features.bed` if `--generate_rescue_features` is used).
|
|
92
|
+
|
|
93
|
+
### 2. Run the Pipeline
|
|
94
|
+
|
|
95
|
+
Quantify all your samples jointly in a single command.
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
majec_run_pipeline \
|
|
99
|
+
--annotation my_annotations_annotations.pkl.gz \
|
|
100
|
+
--bams sample1.bam sample2.bam \
|
|
101
|
+
--prefix my_experiment \
|
|
102
|
+
--paired_end \
|
|
103
|
+
--strandedness 2 \
|
|
104
|
+
--use_subset_penalty \
|
|
105
|
+
--use_junction_completeness \
|
|
106
|
+
--library_type dT \
|
|
107
|
+
--terminal_relax \
|
|
108
|
+
--output_confidence \
|
|
109
|
+
--use_cache
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
Input BAMs should be coordinate-sorted and produced by a splice-aware aligner such as STAR. For TE quantification, use `--outFilterMultimapNmax 100` (or similar) during alignment to retain multimapping reads.
|
|
113
|
+
|
|
114
|
+
## Outputs
|
|
115
|
+
|
|
116
|
+
MAJEC automatically aggregates locus-level estimates and provides DESeq2-ready matrices at multiple resolutions:
|
|
117
|
+
|
|
118
|
+
- `_total_EM_aggregated_counts.tsv` — Gene and subfamily-level counts
|
|
119
|
+
- `_total_EM_counts.tsv` — Isoform and locus-level counts
|
|
120
|
+
- `_transcript_metrics_SPARSE.tsv.gz` — Confidence scores and junction evidence
|
|
121
|
+
|
|
122
|
+
## How It Works
|
|
123
|
+
|
|
124
|
+
1. **Read assignment**: featureCounts assigns reads to features from the joint gene+TE annotation, forming equivalence classes of reads that map to the same set of transcripts.
|
|
125
|
+
|
|
126
|
+
2. **Junction extraction**: splice junctions reported by featureCounts (`.jcounts`) are matched to annotated transcript structures, providing isoform-discriminating evidence.
|
|
127
|
+
|
|
128
|
+
3. **Prior construction**: junction evidence, completeness scores, subset relationships, and (optionally) TSL annotations are combined into per-transcript priors that seed the EM.
|
|
129
|
+
|
|
130
|
+
4. **EM with momentum**: the Expectation-Maximization algorithm iteratively refines transcript abundance estimates. Momentum acceleration speeds convergence, typically reaching stable estimates within ~15 iterations.
|
|
131
|
+
|
|
132
|
+
5. **Output**: final gene-level, transcript-level, and (if applicable) TE locus-level count matrices, plus optional confidence metrics.
|
|
133
|
+
|
|
134
|
+
## Optional Workflow Tools
|
|
135
|
+
|
|
136
|
+
MAJEC includes additional tools for downstream analysis. See the full documentation for details.
|
|
137
|
+
|
|
138
|
+
- **`majec_build_db`** — Consolidate results from one or more pipeline runs into a single, queryable SQLite database. Supports merging chunked runs, attaching sample metadata, and serves as the input for all downstream tools.
|
|
139
|
+
- **`majec_prepare_deseq2`** — Generate ready-to-run DESeq2 analysis packages directly from the database. Supports flexible sample group definitions, confidence-weighted variance modeling, gene/transcript/differential-splicing analysis levels, and batch correction.
|
|
140
|
+
- **`majec_visualize`** — Generate interactive, multi-panel HTML reports for individual genes. Includes junction arc plots, differential splicing heatmaps, per-sample penalty diagnostics, and optional Excel export.
|
|
141
|
+
|
|
142
|
+
## Key Parameters
|
|
143
|
+
|
|
144
|
+
Run `majec_run_pipeline --help` or `majec_precompute_annotations --help` for the full list of options. The most important flags are shown in the Quick Start above. A few others worth noting:
|
|
145
|
+
|
|
146
|
+
| Flag | Description |
|
|
147
|
+
|------|-------------|
|
|
148
|
+
| `--use_subset_coverage_data` | Use read coverage to inform subset penalties (requires `--generate_rescue_features` during annotation precompute) |
|
|
149
|
+
| `--output_tpm` | Output TPM values in addition to counts |
|
|
150
|
+
| `--light` | Skip prior tracking and confidence metrics for faster, leaner runs |
|
|
151
|
+
| `--use_cache` | Cache featureCounts results to speed up reruns with different parameters |
|
|
152
|
+
| `--config` | Load settings from a JSON file (CLI flags override) |
|
|
153
|
+
|
|
154
|
+
## Documentation
|
|
155
|
+
|
|
156
|
+
- [BAM Preparation](docs/bam_preparation.md) — STAR alignment parameters for TE-aware quantification
|
|
157
|
+
- [Algorithm Details](docs/algorithm_details.md) — Two-phase EM, prior adjustment models, momentum acceleration, confidence metrics
|
|
158
|
+
- [Output Files](docs/output_files.md) — Column descriptions for all output tables and confidence reports
|
|
159
|
+
- [Post-Quantification Workflows](docs/post_quantification.md) — Database building, DESeq2 integration, and visualization
|
|
160
|
+
- [Usage Guide](docs/usage_guide.md) — Configuration templates, utility tools, resource requirements, and HPC deployment
|
|
161
|
+
|
|
162
|
+
## Citation
|
|
163
|
+
|
|
164
|
+
If you use MAJEC in your research, please cite:
|
|
165
|
+
|
|
166
|
+
> Lim, T.-Y. & Firestone, A.J. (2026) MAJEC: unified gene, isoform, and locus-level transposable element quantification from RNA-seq. *bioRxiv*.
|
|
167
|
+
|
|
168
|
+
## License
|
|
169
|
+
|
|
170
|
+
Apache License 2.0. See [LICENSE](LICENSE) for details.
|
|
171
|
+
|
majec-0.1.0/README.md
ADDED
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
# MAJEC
|
|
2
|
+
|
|
3
|
+
<img width="2816" height="1536" alt="Gemini_Generated_Image_7e14am7e14am7e14" src="https://github.com/user-attachments/assets/c3a50e27-7bf0-45b5-9e23-8aa55d3551a3" />
|
|
4
|
+
|
|
5
|
+
**Momentum-Accelerated Junction-Enhanced Counting** — unified gene, isoform, and locus-level transposable element quantification from RNA-seq.
|
|
6
|
+
|
|
7
|
+
MAJEC jointly quantifies genes, transcript isoforms, and individual TE loci from standard BAM alignments in a single pass. By operating a probabilistically resolved Expectation-Maximization (EM) algorithm on a **joint gene+TE feature space**, MAJEC eliminates the systematic signal misattribution that plagues existing TE quantification tools.
|
|
8
|
+
|
|
9
|
+
## The Gene-TE Overlap Problem
|
|
10
|
+
|
|
11
|
+
Approximately 45% of the human genome consists of TEs, many of which are embedded directly within gene bodies.
|
|
12
|
+
|
|
13
|
+
* **TE-only tools:** Operate blind to genes. When a host gene is transcribed, its reads are falsely attributed to the overlapping TE, driving massive false-positive TE reactivation calls.
|
|
14
|
+
|
|
15
|
+
**The MAJEC Solution:** Genes and TEs compete for reads probabilistically. MAJEC uses empirical splice junction evidence to heavily penalize unsupported transcript isoforms, preventing them from stealing genuine TE reads, while correctly assigning spliced genic reads to their host genes.
|
|
16
|
+
|
|
17
|
+
## Key Features
|
|
18
|
+
|
|
19
|
+
- **Joint gene+TE feature space**: genes and TE loci compete for reads probabilistically, preventing systematic misattribution at overlapping loci
|
|
20
|
+
- **Junction-informed priors**: splice junction evidence from the BAM drives isoform-level accuracy and helps distinguish genic from TE-derived signal
|
|
21
|
+
- **Locus-level TE resolution**: individual TE insertions are quantified — not just subfamily aggregates
|
|
22
|
+
- **Confidence metrics**: per-transcript distinguishability scores, assignment entropy, and discord scores for transparent quality assessment
|
|
23
|
+
- **Fast**: momentum-accelerated EM typically converges in ~15 iterations; multiprocessing across samples
|
|
24
|
+
|
|
25
|
+
## Installation
|
|
26
|
+
|
|
27
|
+
### From source
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
mamba env create -f majec.yml
|
|
31
|
+
conda activate majec
|
|
32
|
+
pip install -e .
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Dependencies
|
|
36
|
+
|
|
37
|
+
Installed automatically via the conda environment:
|
|
38
|
+
|
|
39
|
+
- [Subread](http://subread.sourceforge.net/) (featureCounts) >= 2.0
|
|
40
|
+
- [samtools](http://www.htslib.org/) >= 1.20
|
|
41
|
+
- [bedtools](https://bedtools.readthedocs.io/) >= 2.31
|
|
42
|
+
|
|
43
|
+
## Quick Start
|
|
44
|
+
|
|
45
|
+
### 1. Precompute Annotations
|
|
46
|
+
|
|
47
|
+
Combine your gene and TE GTFs into a unified, mathematically optimized index.
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
majec_precompute_annotations \
|
|
51
|
+
--gene_gtf gencode.v44.annotation.gtf \
|
|
52
|
+
--te_gtf hg38_rmsk_TE.gtf \
|
|
53
|
+
--output my_annotations
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
This produces `my_annotations_annotations.pkl.gz` (and optionally `_subset_coverage_features.bed` if `--generate_rescue_features` is used).
|
|
57
|
+
|
|
58
|
+
### 2. Run the Pipeline
|
|
59
|
+
|
|
60
|
+
Quantify all your samples jointly in a single command.
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
majec_run_pipeline \
|
|
64
|
+
--annotation my_annotations_annotations.pkl.gz \
|
|
65
|
+
--bams sample1.bam sample2.bam \
|
|
66
|
+
--prefix my_experiment \
|
|
67
|
+
--paired_end \
|
|
68
|
+
--strandedness 2 \
|
|
69
|
+
--use_subset_penalty \
|
|
70
|
+
--use_junction_completeness \
|
|
71
|
+
--library_type dT \
|
|
72
|
+
--terminal_relax \
|
|
73
|
+
--output_confidence \
|
|
74
|
+
--use_cache
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Input BAMs should be coordinate-sorted and produced by a splice-aware aligner such as STAR. For TE quantification, use `--outFilterMultimapNmax 100` (or similar) during alignment to retain multimapping reads.
|
|
78
|
+
|
|
79
|
+
## Outputs
|
|
80
|
+
|
|
81
|
+
MAJEC automatically aggregates locus-level estimates and provides DESeq2-ready matrices at multiple resolutions:
|
|
82
|
+
|
|
83
|
+
- `_total_EM_aggregated_counts.tsv` — Gene and subfamily-level counts
|
|
84
|
+
- `_total_EM_counts.tsv` — Isoform and locus-level counts
|
|
85
|
+
- `_transcript_metrics_SPARSE.tsv.gz` — Confidence scores and junction evidence
|
|
86
|
+
|
|
87
|
+
## How It Works
|
|
88
|
+
|
|
89
|
+
1. **Read assignment**: featureCounts assigns reads to features from the joint gene+TE annotation, forming equivalence classes of reads that map to the same set of transcripts.
|
|
90
|
+
|
|
91
|
+
2. **Junction extraction**: splice junctions reported by featureCounts (`.jcounts`) are matched to annotated transcript structures, providing isoform-discriminating evidence.
|
|
92
|
+
|
|
93
|
+
3. **Prior construction**: junction evidence, completeness scores, subset relationships, and (optionally) TSL annotations are combined into per-transcript priors that seed the EM.
|
|
94
|
+
|
|
95
|
+
4. **EM with momentum**: the Expectation-Maximization algorithm iteratively refines transcript abundance estimates. Momentum acceleration speeds convergence, typically reaching stable estimates within ~15 iterations.
|
|
96
|
+
|
|
97
|
+
5. **Output**: final gene-level, transcript-level, and (if applicable) TE locus-level count matrices, plus optional confidence metrics.
|
|
98
|
+
|
|
99
|
+
## Optional Workflow Tools
|
|
100
|
+
|
|
101
|
+
MAJEC includes additional tools for downstream analysis. See the full documentation for details.
|
|
102
|
+
|
|
103
|
+
- **`majec_build_db`** — Consolidate results from one or more pipeline runs into a single, queryable SQLite database. Supports merging chunked runs, attaching sample metadata, and serves as the input for all downstream tools.
|
|
104
|
+
- **`majec_prepare_deseq2`** — Generate ready-to-run DESeq2 analysis packages directly from the database. Supports flexible sample group definitions, confidence-weighted variance modeling, gene/transcript/differential-splicing analysis levels, and batch correction.
|
|
105
|
+
- **`majec_visualize`** — Generate interactive, multi-panel HTML reports for individual genes. Includes junction arc plots, differential splicing heatmaps, per-sample penalty diagnostics, and optional Excel export.
|
|
106
|
+
|
|
107
|
+
## Key Parameters
|
|
108
|
+
|
|
109
|
+
Run `majec_run_pipeline --help` or `majec_precompute_annotations --help` for the full list of options. The most important flags are shown in the Quick Start above. A few others worth noting:
|
|
110
|
+
|
|
111
|
+
| Flag | Description |
|
|
112
|
+
|------|-------------|
|
|
113
|
+
| `--use_subset_coverage_data` | Use read coverage to inform subset penalties (requires `--generate_rescue_features` during annotation precompute) |
|
|
114
|
+
| `--output_tpm` | Output TPM values in addition to counts |
|
|
115
|
+
| `--light` | Skip prior tracking and confidence metrics for faster, leaner runs |
|
|
116
|
+
| `--use_cache` | Cache featureCounts results to speed up reruns with different parameters |
|
|
117
|
+
| `--config` | Load settings from a JSON file (CLI flags override) |
|
|
118
|
+
|
|
119
|
+
## Documentation
|
|
120
|
+
|
|
121
|
+
- [BAM Preparation](docs/bam_preparation.md) — STAR alignment parameters for TE-aware quantification
|
|
122
|
+
- [Algorithm Details](docs/algorithm_details.md) — Two-phase EM, prior adjustment models, momentum acceleration, confidence metrics
|
|
123
|
+
- [Output Files](docs/output_files.md) — Column descriptions for all output tables and confidence reports
|
|
124
|
+
- [Post-Quantification Workflows](docs/post_quantification.md) — Database building, DESeq2 integration, and visualization
|
|
125
|
+
- [Usage Guide](docs/usage_guide.md) — Configuration templates, utility tools, resource requirements, and HPC deployment
|
|
126
|
+
|
|
127
|
+
## Citation
|
|
128
|
+
|
|
129
|
+
If you use MAJEC in your research, please cite:
|
|
130
|
+
|
|
131
|
+
> Lim, T.-Y. & Firestone, A.J. (2026) MAJEC: unified gene, isoform, and locus-level transposable element quantification from RNA-seq. *bioRxiv*.
|
|
132
|
+
|
|
133
|
+
## License
|
|
134
|
+
|
|
135
|
+
Apache License 2.0. See [LICENSE](LICENSE) for details.
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["poetry-core>=1.0.0"]
|
|
3
|
+
build-backend = "poetry.core.masonry.api"
|
|
4
|
+
|
|
5
|
+
[tool.poetry]
|
|
6
|
+
name = "majec"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "Momentum-Accelerated Junction-Enhanced Counting Ecosystem"
|
|
9
|
+
authors = ["Ari J. Firestone <arijfire@alumni.stanford.edu>"]
|
|
10
|
+
license = "Apache-2.0"
|
|
11
|
+
readme = "README.md"
|
|
12
|
+
packages = [{include = "majec", from = "src"}]
|
|
13
|
+
classifiers = [
|
|
14
|
+
"Programming Language :: Python :: 3",
|
|
15
|
+
"Programming Language :: Python :: 3.11",
|
|
16
|
+
"Programming Language :: Python :: 3.12",
|
|
17
|
+
"License :: OSI Approved :: Apache Software License",
|
|
18
|
+
"Operating System :: POSIX :: Linux",
|
|
19
|
+
"Topic :: Scientific/Engineering :: Bio-Informatics",
|
|
20
|
+
"Intended Audience :: Science/Research",
|
|
21
|
+
]
|
|
22
|
+
|
|
23
|
+
# --- DEPENDENCY DEFINITIONS ---
|
|
24
|
+
# All dependencies, including optional ones, are defined here.
|
|
25
|
+
[tool.poetry.dependencies]
|
|
26
|
+
python = "^3.11"
|
|
27
|
+
|
|
28
|
+
# --- Core Dependencies ---
|
|
29
|
+
numpy = "^2.3"
|
|
30
|
+
pandas = "^2.3"
|
|
31
|
+
|
|
32
|
+
# --- Optional Dependencies ---
|
|
33
|
+
# They are defined here but marked as "optional".
|
|
34
|
+
# They will only be installed if an "extra" group calls them.
|
|
35
|
+
intervaltree = { version = "^3.1", optional = true }
|
|
36
|
+
polars = { version = ">=1.33", optional = true }
|
|
37
|
+
plotly = { version = ">=6.3", optional = true }
|
|
38
|
+
python-kaleido = { version = ">=1.0", optional = true }
|
|
39
|
+
pypdf2 = { version = ">=3.0", optional = true }
|
|
40
|
+
scipy = { version = ">=1.16", optional = true }
|
|
41
|
+
xlsxwriter = { version = ">=3.1", optional = true }
|
|
42
|
+
pytest = { version = "^8.0", optional = true } # For development
|
|
43
|
+
|
|
44
|
+
# --- OPTIONAL DEPENDENCY GROUPS ("EXTRAS") ---
|
|
45
|
+
# This section now contains ONLY the names of the packages.
|
|
46
|
+
# The versions are managed in the section above.
|
|
47
|
+
[tool.poetry.extras]
|
|
48
|
+
database = ["polars"]
|
|
49
|
+
viz = ["plotly", "python-kaleido", "pypdf2", "xlsxwriter"]
|
|
50
|
+
tools = ["scipy"]
|
|
51
|
+
full_analysis = ["polars", "plotly", "python-kaleido", "pypdf2", "scipy", "intervaltree"]
|
|
52
|
+
dev = ["pytest"]
|
|
53
|
+
|
|
54
|
+
# --- SCRIPT ENTRY POINTS ---
|
|
55
|
+
[tool.poetry.scripts]
|
|
56
|
+
majec_run_pipeline = "majec.pipeline:main"
|
|
57
|
+
majec_precompute_annotations = "majec.preprocess:main"
|
|
58
|
+
majec_build_db = "majec.database:main"
|
|
59
|
+
majec_add_norm_factors = "majec.tools.normalization:main"
|
|
60
|
+
majec_prepare_deseq2 = "majec.analysis.deseq2:main"
|
|
61
|
+
majec_visualize = "majec.analysis.visualization:main"
|
|
62
|
+
majec_calc_frag_len = "majec.tools.fragment_lengths:main"
|
|
63
|
+
majec_calc_thresholds = "majec.tools.thresholds:main"
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
__version__ = "0.1.0"
|
|
File without changes
|