Skip to content

Package the tool. Support gatk4 from conda. Add --genome option.#12

Open
vladsavelyev wants to merge 5 commits into
nygenome:masterfrom
vladsavelyev:master
Open

Package the tool. Support gatk4 from conda. Add --genome option.#12
vladsavelyev wants to merge 5 commits into
nygenome:masterfrom
vladsavelyev:master

Conversation

@vladsavelyev

Copy link
Copy Markdown

Proposing changes that would allow distribution with bioconda and bcbio-nextgen.

  1. Packaging the tool so can be installed with ./setup.py install / ./setup.py develop, or uploaded into PyPI repository to be installed with pip. Corresponding code changes:
  • rename "modules" to "conpair" to avoid clashes with other libs on system,
  • import module files instead of sourcing with imp,
  • add setup.py,
  • move common functions to conpair/__init__.py,
  • .gitignore'd artefacts eggs/dist/build.
  1. If gatk executable is available in PATH, the tool will assume it's GATK4 and use it directly (unless --gatk or $GATK_JAR are set). It allows to use GATK4 from bioconda. (resolves Support GATK 4 #11).

  2. GRCh37 is assumed by default and corresponding markers files are searched, however if the users want to run against GRCh38 or the mouse genome, they can specify genome build name with -g/--genome option (as an alternative to referencing the markers file directly with --markers).

1. The tools can be installed with `./setup.py install`/`./setup.py develop`, or uploaded into PyPI repository to be installed with pip. Corresponding code changes:
- rename "modules" to "conpair" to avoid clashes with other libs on system
- import module files instead of sourcing with imp
- add setup.py
- move common functions to conpair/__init__.py
- .gitignore eggs/dist/build

2. If `gatk` executable is available in PATH, the tool will assume it's GATK4 and use it directly (unless --gatk or $GATK_JAR set). It allows to use GATK4 from bioconda.

3. GRCh37 is assumed by default, however if you want to run against GRCh38 or mouse genome, you can specify genome build name with `-g`/`--genome` option (as an alternative to referencing the markers file directly with `--markers`)
…mples out into the root folder. Add pip and conda install docs. CONPAIR_DIR env var is not needed
(it prints lines without the 5th column in the pileup output)
stevekm added a commit to stevekm/Conpair that referenced this pull request Apr 18, 2025
@MikeWLloyd

Copy link
Copy Markdown

@vladsavelyev, I just wanted to say thank you for doing this work and putting in the PR. It got me out of a bind with some errors I was seeing, hopefully it gets pulled into main eventually.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Support GATK 4

2 participants