Skip to content

Commit ce12c1e

Browse files
luispedroluispedro
committed
RLS Version 0.3.0
Full Changelog HANDLING GENE CLUSTERS & REVERSE COMPLEMENTS IN RESFINDER - Resfinder has gene clusters which can't be passed through RGI using 'contig' mode. - Gene clusters were identified and were manually assigned ARO numbers. - A seperate file with manual curation for gene clusters and RCs was created, and their AROs were updated after concatenating RGI results and genes not in RGI results. - 40 gene clusters present. - 9 genes in reverse complement form also present. - RC genes were manually curated. USING AMINO ACID FILE FOR ARGANNOT & RESFINDER RATHER THAN NUCLEOTIDE FILE - ARG-ANNOT and Resfinder are comprised of coding sequences. The data wasn't being handled properly before as contig mode was used when passing coding sequences to RGI. Now, the amino acid versions of ARG-ANNOT & Resfinder are used with protein mode when running the database in RGI. - ARG-ANNOT AA file is available online. Resfinder AA file is generated using biopython. - One to many ARO mapping such as NG_047831:101-955 to Erm(K) and almG in ARG-ANNOT eliminated as protein mode used - A total of 10 ARO mappings changed in ARG-ANNOT ARGNORM.LIB: MAKING ARGNORM MORE USABLE AS A LIBRARY - Introduce `argnorm.lib` module - Users can import the `map_to_aro` function from `argnorm.lib`. The function takes a gene name as input, maps the gene to the ARO and returns a pronto term object with the ARO mapping. - The `get_aro_mapping_table` function, previously within the BaseNormalizer class, has also been moved to `lib.py` to give users the ability to access the mapping tables being used for normalization. - With the introduction of `lib.py`, users will be able to access core mapping utilities through `argnorm.lib`, drug categorization through `argnorm.drug_categorization`, and the traditional normalizers through `argnorm.normalizers`.
1 parent 1f0788c commit ce12c1e

File tree

3 files changed

+53
-47
lines changed

3 files changed

+53
-47
lines changed

‎CHANGELOG.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Changelog
22

3-
## Unreleased
3+
4+
## 0.3.0 - 27 April 2024
45

56
### Handling gene clusters & reverse complements in resfinder
67
- Resfinder has gene clusters which can't be passed through RGI using 'contig' mode.
@@ -17,11 +18,12 @@
1718
- A total of 10 ARO mappings changed in ARG-ANNOT
1819

1920
### argnorm.lib: Making argNorm more usable as a library
20-
- A file called `lib.py` will be introduced so that users can use argNorm as a library more easily.
21-
- Users can import the `map_to_aro` function using `from argnorm.lib import map_to_aro`. The function takes a gene name as input, maps the gene to the ARO and returns a pronto term object with the ARO mapping.
21+
- Introduce `argnorm.lib` module
22+
- Users can import the `map_to_aro` function from `argnorm.lib`. The function takes a gene name as input, maps the gene to the ARO and returns a pronto term object with the ARO mapping.
2223
- The `get_aro_mapping_table` function, previously within the BaseNormalizer class, has also been moved to `lib.py` to give users the ability to access the mapping tables being used for normalization.
2324
- With the introduction of `lib.py`, users will be able to access core mapping utilities through `argnorm.lib`, drug categorization through `argnorm.drug_categorization`, and the traditional normalizers through `argnorm.normalizers`.
2425

26+
2527
## 0.2.0 - 26 March 2024
2628

2729
#### ARO Mapping & Normalization

docs/images/whatsnew.md renamed to docs/whatsnew.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
## What's New
22

3+
## 0.3.0 - 27 April 2024
4+
5+
### User-facing changes
6+
- Improved Resfinder mappings (40 gene clusters and 9 reverse complements were manually curated)
7+
- Updated ARG-ANNOT mappings (a total of 10 mappings changed)
8+
- argNorm is now more usable as a library
9+
- Remove warnings
10+
11+
### Internal changes
12+
- Code has been refactored to be simpler
13+
14+
315
## 0.2.0 - 26 March 2024
416

517
#### ARO Mapping & Normalization

‎setup.py‎

Lines changed: 36 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,42 @@
11
from setuptools import setup
2-
from setuptools import find_packages
32

4-
NAME = "argnorm"
5-
AUTHOR = "See README"
6-
EMAIL = "luispedro@big-data-biology.org"
7-
URL = "https://github.com/BigDataBiology/argNorm"
8-
LICENSE = "MIT"
93
DESCRIPTION = """
10-
Normalize antibiotic resistance genes (ARGs) abundance tables (e.g., from metagenomics) by using the ARO ontology (developed by CARD).
11-
4+
Normalize antibiotic resistance genes (ARGs) results by using the ARO ontology (developed by CARD).
125
"""
136

147

15-
if __name__ == "__main__":
16-
setup(
17-
name=NAME,
18-
version="0.2.0",
19-
author=AUTHOR,
20-
author_email=EMAIL,
21-
url=URL,
22-
license=LICENSE,
23-
description=DESCRIPTION,
24-
packages=['argnorm', 'argnorm.data'],
25-
include_package_data=True,
26-
package_dir={'argnorm': 'argnorm' },
27-
package_data={'argnorm': ['data/*.tsv', 'data/manual_curation/*.tsv']},
28-
install_requires=open("./requirements.txt", "r").read().splitlines(),
29-
long_description=open("./README.md", "r").read(),
30-
long_description_content_type='text/markdown',
31-
entry_points={
32-
"console_scripts": [
33-
"argnorm=argnorm.cli:main"
34-
]
35-
},
36-
zip_safe=False,
37-
classifiers=[
38-
"Topic :: Scientific/Engineering :: Bio-Informatics",
39-
"Programming Language :: Python :: 3.7",
40-
"Programming Language :: Python :: 3.8",
41-
"Programming Language :: Python :: 3.9",
42-
"Programming Language :: Python :: 3.10",
43-
"Programming Language :: Python :: 3.11",
44-
"Programming Language :: Python :: 3.12",
45-
"Development Status :: 4 - Beta",
46-
"License :: OSI Approved :: MIT License",
47-
"Operating System :: OS Independent",
48-
"Natural Language :: English"
49-
],
50-
)
8+
setup(
9+
name='argnorm',
10+
version="0.3.0",
11+
author='ArgNorm Developers',
12+
author_email='luispedro@big-data-biology.org',
13+
url="https://github.com/BigDataBiology/argNorm",
14+
license='MIT',
15+
description=DESCRIPTION,
16+
packages=['argnorm', 'argnorm.data'],
17+
include_package_data=True,
18+
package_dir={'argnorm': 'argnorm' },
19+
package_data={'argnorm': ['data/*.tsv', 'data/manual_curation/*.tsv']},
20+
install_requires=open("./requirements.txt", "r").read().splitlines(),
21+
long_description=open("./README.md", "r").read(),
22+
long_description_content_type='text/markdown',
23+
entry_points={
24+
"console_scripts": [
25+
"argnorm=argnorm.cli:main"
26+
]
27+
},
28+
zip_safe=False,
29+
classifiers=[
30+
"Topic :: Scientific/Engineering :: Bio-Informatics",
31+
"Programming Language :: Python :: 3.7",
32+
"Programming Language :: Python :: 3.8",
33+
"Programming Language :: Python :: 3.9",
34+
"Programming Language :: Python :: 3.10",
35+
"Programming Language :: Python :: 3.11",
36+
"Programming Language :: Python :: 3.12",
37+
"Development Status :: 4 - Beta",
38+
"License :: OSI Approved :: MIT License",
39+
"Operating System :: OS Independent",
40+
"Natural Language :: English"
41+
],
42+
)

0 commit comments

Comments
 (0)