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

Use pkgdepends #20

Merged
merged 9 commits into from
Jul 30, 2024
Merged

Use pkgdepends #20

merged 9 commits into from
Jul 30, 2024

Conversation

Faizal-Eeman
Copy link
Contributor

@Faizal-Eeman Faizal-Eeman commented Jul 27, 2024

Description

This PR adds pkgdepends to install Battenberg and other dependencies.

Closes #...

Testing Results

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:

docker run --rm -u $(id -u):$(id -g) battenberg:2.2.9 Rscript /usr/local/bin/battenberg_wgs.R -h

[mmootor@ip-0A125937 docker-Battenberg]$ docker run --rm -u $(id -u):$(id -g) bb:2.2.9 Rs
cript /usr/local/bin/battenberg_wgs.R -h
Usage: /usr/local/bin/battenberg_wgs.R [options]


Options:
        -t CHARACTER, --tumourname=CHARACTER
                Samplename of the tumour

        -n CHARACTER, --normalname=CHARACTER
                Samplename of the normal

        --tb=CHARACTER
                Tumour BAM file

        --nb=CHARACTER
                Normal BAM file

        --sex=CHARACTER
                Sex of the sample

        -o CHARACTER, --output=CHARACTER
                Directory where output will be written

        --skip_allelecount
                Provide when alleles don't have to be counted. This expects allelecount files on disk

        --skip_preprocessing
                Provide when pre-processing has previously completed. This expects the files on disk

        --skip_phasing
                Provide when phasing has previously completed. This expects the files on disk

        --cpu=CHARACTER
                The number of CPU cores to be used by the pipeline (Default: 8)

        --bp=CHARACTER
                Optional two column file (chromosome and position) specifying prior breakpoints to be used during segmentation

        -h, --help
                Show this help message and exit

Checklist

Formatting

File Updates

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

  • I have updated the version number in the Dockerfile, README.md and metadata.yaml files.

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

  • I have updated the feature changes in the README.md (optional).

  • 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.

GitHub Packages Auto Build Rules

  • I have not manually pushed this Docker image to the uclahs-cds container registry (ghcr.io/uclahs-cds) on GitHub.

  • I have updated the image_name in the metadata.yaml which is required by GitHub action to automatically build and push the image.

@wiz-inc-8da00b022c
Copy link

wiz-inc-8da00b022c bot commented Jul 27, 2024

Wiz Scan Summary

IaC Misconfigurations 0C 0H 7M 1L 0I
Vulnerabilities 0C 0H 0M 0L 0I
Sensitive Data 0C 0H 0M 0L 0I
Total 0C 0H 7M 1L 0I
Secrets 0🔑

Copy link

@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!

Dockerfile Outdated Show resolved Hide resolved
@Faizal-Eeman Faizal-Eeman merged commit 7843dc7 into main Jul 30, 2024
5 checks passed
@Faizal-Eeman Faizal-Eeman deleted the mmootor-use-pkgdepends branch July 30, 2024 19:07
@nwiltsie nwiltsie mentioned this pull request Aug 16, 2024
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