Sovereign 8s.is mirror of standardgalactic/genemasker
  • Python 99.4%
  • Dockerfile 0.6%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-04-30 13:11:50 +00:00
docker initial commit 2025-02-14 10:05:42 -05:00
docs first pass documentation 2026-03-22 09:25:53 -04:00
env initial commit 2025-02-14 10:05:42 -05:00
genemasker improved messaging for tracking variant filtering 2026-04-30 13:11:50 +00:00
.gitignore initial commit 2025-02-14 10:05:42 -05:00
LICENSE Initial commit 2025-02-14 10:02:14 -05:00
README.rst update to zenodo badge 2026-03-22 13:58:29 +00:00
setup.cfg initial commit 2025-02-14 10:05:42 -05:00
setup.py initial commit 2025-02-14 10:05:42 -05:00

genemasker
**********

This application produces masked group/gene variant inclusion files for rare variant analysis.

|DOI|

.. |DOI| image:: https://zenodo.org/badge/932808322.svg
   :target: https://zenodo.org/badge/latestdoi/932808322
   :alt: DOI

Installation
************

This application has been tested using the following version of Python and required modules.
   - python=3.9.21
   - numpy=2.0.2
   - pandas=2.2.3
   - scikit-learn=1.6.1
   - scipy=1.13.1
   - psutil=6.1.1
   - dask=2024.8.0

It can be installed in a conda environment via the provided yml file as below.

.. code-block:: bash

   conda env create -f env/environment.yml
   source activate genemasker

With your environment activated, you are ready to install genemasker.

.. code-block:: bash

   python setup.py install

Another option is to run genemasker via Docker (see the included Dockerfile).

Getting Started
***************

.. code-block:: bash

   source activate genemasker

Verify that genemasker is functional using the following command to display help.

.. code-block:: bash

   genemasker --help