Skip to content

Commit c0d6ff3

Browse files
authored
Merge pull request #6 from asntech/j2026
Addeded JASPAR 2026 release
2 parents eaa9e81 + 4fd4c07 commit c0d6ff3

File tree

6 files changed

+79
-706
lines changed

6 files changed

+79
-706
lines changed

CITATION.cff

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
cff-version: 1.2.0
2+
3+
message: "If you use this software, please cite it using the following reference."
4+
title: "pyJASPAR: a Pythonic interface to JASPAR transcription factor motifs"
5+
date-released: "2021-02-01"
6+
authors:
7+
- family-names: "Khan"
8+
given-names: "Aziz"
9+
orcid: "https://orcid.org/0000-0002-6459-6224"
10+
version: 4.0.0
11+
identifiers:
12+
- type: doi
13+
value: 10.5281/zenodo.4509415"

LICENSE

Lines changed: 21 additions & 674 deletions
Large diffs are not rendered by default.

README.rst

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ pyJASPAR
55

66
**pyJASPAR** uses *Biopython* and *SQLite3* to provide a serverless interface to `JASPAR database <http://jaspar.genereg.net>`_ to query and access TF motif profiles across various releases of JASPAR.
77

8-
98
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4509415.svg
109
:target: https://doi.org/10.5281/zenodo.4509415
1110

@@ -28,11 +27,12 @@ pyJASPAR
2827
:target: https://github.com/asntech/pyjaspar/issues
2928

3029

31-
pyJASPAR provides access to the following releases of JASPAR database: *JASPAR2024*, *JASPAR2022*, *JASPAR2020*, *JASPAR2018*, *JASPAR2016*, *JASPAR2014*.
30+
pyJASPAR provides access to the following releases of JASPAR database: *JASPAR2026*, *JASPAR2024*, *JASPAR2022*, *JASPAR2020*, *JASPAR2018*, *JASPAR2016*, *JASPAR2014*.
3231

3332
**Note**: This is a serverless SQLite wrapper around the Biopython JASPAR module `Bio.motifs.jaspar.db` which requires JASPAR MySQL database sever connection details.
3433

3534

35+
3636
Documentation
3737
-------------
3838

@@ -42,6 +42,9 @@ Documentation
4242
Installation
4343
------------
4444

45+
**Note**: The *JASPAR2026* release is available for peer-review purpose via GitHub only. It will be made public after the official release of JASPAR2026 database.
46+
47+
4548
Quick installation using conda
4649
================================
4750
pyJASPAR is available on `Bioconda <https://anaconda.org/bioconda/pyjaspar>`_ for installation via ``conda``.
@@ -86,8 +89,8 @@ Once you have installed pyjaspar, you can create jaspardb class object:
8689
8790
>>> from pyjaspar import jaspardb
8891
89-
#Create the JASPAR2022 release object
90-
>>> jdb_obj = jaspardb(release='JASPAR2024')
92+
#Create the JASPAR2026 release object
93+
>>> jdb_obj = jaspardb(release='JASPAR2026')
9194
9295
#Fetch motif by ID
9396
>>> motif = jdb_obj.fetch_motif_by_id('MA0095.2')
@@ -112,7 +115,7 @@ Once you have installed pyjaspar, you can create jaspardb class object:
112115
tax_group = ['Vertebrates'],
113116
all_versions = False)
114117
>>> print(len(motifs))
115-
879
118+
1019
116119
## loop through the motifs list and perform analysis
117120
>>> for motif in motifs:
118121
pass
@@ -125,12 +128,12 @@ Find available releases
125128
.. code-block:: pycon
126129
127130
>>> print(jdb_obj.get_releases())
128-
['JASPAR2024','JASPAR2022','JASPAR2020', 'JASPAR2018', 'JASPAR2016', 'JASPAR2014']
131+
['JASPAR2026', 'JASPAR2024','JASPAR2022','JASPAR2020', 'JASPAR2018', 'JASPAR2016', 'JASPAR2014']
129132
130133
131134
Cite
132135
=====
133-
- Aziz Khan. pyJASPAR: a Pythonic interface to JASPAR transcription factor motifs. (2021). doi:10.5281/zenodo.4509415
136+
- Aziz Khan. pyJASPAR: a Pythonic interface to JASPAR transcription factor motifs. (2021). Zenodo, doi:10.5281/zenodo.4485856
134137

135138
.. code-block:: bash
136139
@@ -140,7 +143,7 @@ Cite
140143
month = feb,
141144
year = 2021,
142145
publisher = {Zenodo},
143-
version = {v2.0.0},
144-
doi = {10.5281/zenodo.4509415},
145-
url = {https://doi.org/10.5281/zenodo.4509415}
146+
version = {v4.0.0},
147+
doi = {10.5281/zenodo.4485856},
148+
url = {https://doi.org/10.5281/zenodo.4485856}
146149
}

pyjaspar/__init__.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
pass # do something with the motif
4444
"""
4545

46-
__version__ = '3.0.0'
46+
__version__ = '4.0.0'
4747

4848
import warnings
4949
from Bio import BiopythonWarning
@@ -55,6 +55,7 @@
5555
from .utils import *
5656

5757
jaspar_releases = {
58+
'JASPAR2026': 'JASPAR2026.sqlite',
5859
'JASPAR2024': 'JASPAR2024.sqlite',
5960
'JASPAR2022': 'JASPAR2022.sqlite',
6061
'JASPAR2020': 'JASPAR2020.sqlite',
@@ -63,7 +64,7 @@
6364
'JASPAR2014': 'JASPAR2014.sqlite',
6465
}
6566

66-
JASPAR_LATEST_RELEASE = "JASPAR2024"
67+
JASPAR_LATEST_RELEASE = "JASPAR2026"
6768

6869
JASPAR_DFLT_COLLECTION = "CORE"
6970

pyjaspar/data/JASPAR2026.sqlite

15.3 MB
Binary file not shown.

pyjaspar_notebook.ipynb

Lines changed: 29 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
},
1717
{
1818
"cell_type": "code",
19-
"execution_count": 22,
19+
"execution_count": 1,
2020
"metadata": {},
2121
"outputs": [],
2222
"source": [
@@ -33,11 +33,11 @@
3333
},
3434
{
3535
"cell_type": "code",
36-
"execution_count": 23,
36+
"execution_count": 4,
3737
"metadata": {},
3838
"outputs": [],
3939
"source": [
40-
"jdb_obj = jaspardb(release='JASPAR2024')"
40+
"jdb_obj = jaspardb(release='JASPAR2026')"
4141
]
4242
},
4343
{
@@ -49,7 +49,7 @@
4949
},
5050
{
5151
"cell_type": "code",
52-
"execution_count": 24,
52+
"execution_count": 6,
5353
"metadata": {
5454
"scrolled": true
5555
},
@@ -58,7 +58,7 @@
5858
"name": "stdout",
5959
"output_type": "stream",
6060
"text": [
61-
"JASPAR2024\n"
61+
"JASPAR2026\n"
6262
]
6363
}
6464
],
@@ -75,14 +75,14 @@
7575
},
7676
{
7777
"cell_type": "code",
78-
"execution_count": 25,
78+
"execution_count": 7,
7979
"metadata": {},
8080
"outputs": [
8181
{
8282
"name": "stdout",
8383
"output_type": "stream",
8484
"text": [
85-
"JASPAR2024\n"
85+
"JASPAR2026\n"
8686
]
8787
}
8888
],
@@ -101,14 +101,14 @@
101101
},
102102
{
103103
"cell_type": "code",
104-
"execution_count": 26,
104+
"execution_count": 8,
105105
"metadata": {},
106106
"outputs": [
107107
{
108108
"name": "stdout",
109109
"output_type": "stream",
110110
"text": [
111-
"['JASPAR2024', 'JASPAR2022', 'JASPAR2020', 'JASPAR2018', 'JASPAR2016', 'JASPAR2014']\n"
111+
"['JASPAR2026', 'JASPAR2024', 'JASPAR2022', 'JASPAR2020', 'JASPAR2018', 'JASPAR2016', 'JASPAR2014']\n"
112112
]
113113
}
114114
],
@@ -126,7 +126,7 @@
126126
},
127127
{
128128
"cell_type": "code",
129-
"execution_count": 27,
129+
"execution_count": 9,
130130
"metadata": {},
131131
"outputs": [],
132132
"source": [
@@ -142,7 +142,7 @@
142142
},
143143
{
144144
"cell_type": "code",
145-
"execution_count": 28,
145+
"execution_count": 10,
146146
"metadata": {},
147147
"outputs": [
148148
{
@@ -152,8 +152,8 @@
152152
"TF name\tAhr::Arnt\n",
153153
"Matrix ID\tMA0006.1\n",
154154
"Collection\tCORE\n",
155-
"TF class\t['Basic helix-loop-helix factors (bHLH)', 'Basic helix-loop-helix factors (bHLH)']\n",
156-
"TF family\t['PAS domain factors', 'PAS domain factors']\n",
155+
"TF class\t['Basic helix-loop-helix factors (bHLH)']\n",
156+
"TF family\t['PAS domain factors']\n",
157157
"Species\t10090\n",
158158
"Taxonomic group\tvertebrates\n",
159159
"Accession\t['P30561', 'P53762']\n",
@@ -185,7 +185,7 @@
185185
},
186186
{
187187
"cell_type": "code",
188-
"execution_count": 29,
188+
"execution_count": 11,
189189
"metadata": {
190190
"scrolled": true
191191
},
@@ -364,7 +364,7 @@
364364
"name": "stdout",
365365
"output_type": "stream",
366366
"text": [
367-
"879\n"
367+
"1019\n"
368368
]
369369
}
370370
],
@@ -374,7 +374,7 @@
374374
},
375375
{
376376
"cell_type": "code",
377-
"execution_count": 25,
377+
"execution_count": 17,
378378
"metadata": {},
379379
"outputs": [],
380380
"source": [
@@ -392,13 +392,15 @@
392392
},
393393
{
394394
"cell_type": "code",
395-
"execution_count": 17,
395+
"execution_count": 18,
396396
"metadata": {},
397397
"outputs": [
398398
{
399399
"name": "stdout",
400400
"output_type": "stream",
401401
"text": [
402+
"JASPAR2026\n",
403+
"2633\n",
402404
"JASPAR2024\n",
403405
"2346\n",
404406
"JASPAR2022\n",
@@ -426,6 +428,13 @@
426428
" print(len(motifs))"
427429
]
428430
},
431+
{
432+
"cell_type": "code",
433+
"execution_count": null,
434+
"metadata": {},
435+
"outputs": [],
436+
"source": []
437+
},
429438
{
430439
"cell_type": "code",
431440
"execution_count": null,
@@ -436,7 +445,7 @@
436445
],
437446
"metadata": {
438447
"kernelspec": {
439-
"display_name": "Python 3",
448+
"display_name": "Python 3 (ipykernel)",
440449
"language": "python",
441450
"name": "python3"
442451
},
@@ -450,9 +459,9 @@
450459
"name": "python",
451460
"nbconvert_exporter": "python",
452461
"pygments_lexer": "ipython3",
453-
"version": "3.8.6"
462+
"version": "3.8.20"
454463
}
455464
},
456465
"nbformat": 4,
457-
"nbformat_minor": 2
466+
"nbformat_minor": 4
458467
}

0 commit comments

Comments
 (0)