ec-finder
EcFinder: Python library and script to fuzzy search an enzyme EC number from an enzyme name
Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 1 committers (100.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.5%) to scientific vocabulary
Repository
EcFinder: Python library and script to fuzzy search an enzyme EC number from an enzyme name
Basic Info
- Host: GitHub
- Owner: ggonnella
- License: other
- Language: Python
- Default Branch: main
- Size: 10.7 KB
Statistics
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
EcFinder
EcFinder tries to find an EC number for an enzyme name using exact and fuzzy search.
It automatically downloads the EC data file from Expasy.
Installation
It can be installed using pip install ec_finder.
CLI
The CLI tool ec-find is provided by the package.
Setup
The first time the tool is called from the command line, the enzyme
data file is downloaded from Expasy. To update the file if a new file
is available, use ec-find update.
To remove the file (e.g. to force an update), use ec-find cleanup.
Search
Use ec-find "enzyme name" to find the EC number for an enzyme name.
Note the quotes, necessary if there are spaces.
Use ec-find filename 1 to find the EC number for all enzyme names
in a file, where each line contains only an enzyme name each.
Use ec-find filename colnum to find the EC number for all enzyme names
in a Tab-separated file, where enzyme names are in the column with the
specified 1-based column number.
Use ec-find filename colnum --separator S to find the EC number for all
enzyme names in a file separated by separator S.
API
The first time that ec_finder is imported, the package
data is downloaded from Expasy.
The ec_finder.update() function can be used to check if new
enzyme data is avalaible at Expasy and, if so, download it and update
the data. The ec.finder.cleanup() function deletes the data.
The ec_finder.search(enzyme_name) function is used for searching
for an enzyme name.
Output format
The output format consists of three fields, separated by the separator
indicated in the --separator option (CLI), or by the separator argument
of search() (API). By default the Tab is used.
The three fields are: - result comment - result EC - enzyme name (input)
The result comment may be: - MAIN, the enzyme name was found as one of the main enzye names. - ALT, the enzyme name was found as one of the alternative enzyme names. - FUZZY:foobar, the enzyme name was not found, but a similar one (foobar) was found - NOT_FOUND, the enzyme name was not found (in this case EC is empty)
If the input of the CLI tool ec-find is a file, then each file line
is output after the three fields reported above, separated from it by the
separator (default: tab).
Settings
The minimum score for the fuzzy search is by default "90" and can be set
to a value between 0 and 100 by the option --min-score of the CLI
or by the argument min_score of the API function search().
The separator in the output is by default TAB and can be set by
the CLI option --separator (which also changes the input separator,
if the input is a file) or by the API function search() argument
separator.
Owner
- Name: Giorgio Gonnella
- Login: ggonnella
- Kind: user
- Location: Goettingen, Germany
- Company: Bioinformatics, University of Goettingen
- Repositories: 36
- Profile: https://github.com/ggonnella
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Gonnella" given-names: "Giorgio" orcid: "https://orcid.org/0000-0003-3900-5397" title: 'EcFinder: search EC numbers for enzyme names' version: 0.1 date-released: 2023-04-04 url: "htts://github.com/ggonnella/ec_finder"
GitHub Events
Total
Last Year
Committers
Last synced: about 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| Giorgio Gonnella | g****a@z****e | 4 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 23 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 1
- Total maintainers: 1
pypi.org: ec-finder
Find suitable EC numbers from enzyme names
- Homepage: https://github.com/ggonnella/ec_finder
- Documentation: https://ec-finder.readthedocs.io/
- License: ISC
-
Latest release: 0.1
published about 3 years ago