Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to v2.2.1_samtools-1.17 and add auto build function, update Dockerfile to meet current standards #7

Merged
merged 2 commits into from
Jul 14, 2023

Conversation

bethneilsen
Copy link
Contributor

Formatting

File Updates

  • I have ensured that the version number update follows the versioning standards.

  • I have updated the version number/dependencies and added my name to the maintainer list in the Dockerfile.

  • I have updated the version number/feature changes in the README.md.

  • I have updated the version number and added my name to the contributors list in the metadata.yaml.

  • I have added the changes included in this pull request to the CHANGELOG.md under the next release version or unreleased, and updated the date.

  • I have drafted the new version release with any additions/changes and have linked the CHANGELOG.md in the release.

Docker Hub Auto Build Rules

  • I have created automated build rules following this page and I have not manually pushed this Docker image to the blcdsdockerregistry on Docker Hub.

Docker Image Testing

  • I have tested the Docker image with the docker run command as described below.

Test the Docker image with at least one sample. Verify the new Docker image works using:

docker run -u $(id -u):$(id -g) –w <working-directory> -v <directory-you-want-to-mount>:<how-you-want-to-mount-it-within-the-docker> --rm <docker-image-name> <command-to-the-docker-with-all-parameters>

My command:

Case 1: docker run --rm -u $(id -u):$(id -g) hisat2:latest hisat2 version

Case 2: docker run --rm -u $(id -u):$(id -g) hisat2:latest samtools version

Testing Results

Case 1:
HISAT2 version 2.2.1 by Daehwan Kim ([email protected], www.ccb.jhu.edu/people/infphilo)
Usage:
hisat2 [options]* -x {-1 -2 | -U } [-S ]

Index filename prefix (minus trailing .X.ht2).
Files with #1 mates, paired with files in .
Could be gzip'ed (extension: .gz) or bzip2'ed (extension: .bz2).
Files with #2 mates, paired with files in .
Could be gzip'ed (extension: .gz) or bzip2'ed (extension: .bz2).
Files with unpaired reads.
Could be gzip'ed (extension: .gz) or bzip2'ed (extension: .bz2).
File for SAM output (default: stdout)

, , can be comma-separated lists (no whitespace) and can be
specified many times. E.g. '-U file1.fq,file2.fq -U file3.fq'.

Options (defaults in parentheses):
...

Case 2:
samtools 1.17
Using htslib 1.17
Copyright (C) 2023 Genome Research Ltd.

Description

Closes NA - Updates SAMTools to the latest version 1.17, added auto build Docker functionality, updated to use mamba to build to meet current Docker standards

Partially addresses issue #258 within pipeline-align-DNA

Copy link
Contributor

@yashpatel6 yashpatel6 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally, looks good! A couple of comments:

CHANGELOG.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Dockerfile Outdated Show resolved Hide resolved
….0-3, update changelog to use new release tag v2.2.1_samtools-v1.17
@bethneilsen bethneilsen marked this pull request as draft July 12, 2023 21:19
@bethneilsen bethneilsen marked this pull request as ready for review July 12, 2023 22:38
@bethneilsen bethneilsen requested review from yashpatel6 and removed request for tyamaguchi-ucla July 12, 2023 22:39
Copy link
Contributor

@yashpatel6 yashpatel6 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@bethneilsen bethneilsen merged commit 89fe4fd into main Jul 14, 2023
@bethneilsen bethneilsen deleted the bneilsen-UpdateSAMToolsTov1.17 branch July 14, 2023 23:33
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.

2 participants