freqsap 1.1.1

Badges

(Customize these badges with your own links, and check https://shields.io/ or https://badgen.net/ to see which other badges are available.)

fair-software.eu recommendations
(1/5) code repository
(2/5) license
(3/5) community registry
(4/5) citation
(5/5) checklist
howfairis
Other best practices
Documentation
Build
Link checker

How to use freqsap

freqsap can be used to query the frequency of single amino-acid polymorphisms.

The project setup is documented in project_setup.md. Feel free to remove this document (and/or the link to this document) if you don't need it.

Installation

Install from PyPI:

python -m pip install freqsap

Install from GitHub repository:

git clone git@github.com:RECETOX/freqsap.git
cd freqsap
python -m pip install .

Command line usage

Display CLI help:

freqsap --help

Run a query:

freqsap \
	--accession P02792 \
	--regions European,East Asian \
	--output-file P02792_frequency.tsv

Common options:

• --delimiter: output delimiter (default is tab). Use xlsx for Excel output.
• --timeout: timeout for REST API calls in seconds (default: 30).

Example with Excel output:

freqsap \
	--accession P02792 \
	--regions European,East Asian \
	--delimiter xlsx \
	--output-file P02792_frequency.xlsx

Version information

Show the CLI version:

freqsap --version

Show the Python package version:

python -c "import freqsap; print(freqsap.__version__)"

Documentation

Include a link to your project's full documentation here.

Contributing

If you want to contribute to the development of freqsap, have a look at the contribution guidelines.

Credits

This package was created with Copier and the NLeSC/python-template.