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

add support for unmmapped bams #98

Merged
merged 3 commits into from
Jun 25, 2024
Merged

add support for unmmapped bams #98

merged 3 commits into from
Jun 25, 2024

Conversation

zhuchcn
Copy link
Member

@zhuchcn zhuchcn commented Jun 6, 2024

Description

Command line argument -u/--unmapped-bam was added to avoid the error of pysam.quickcheck for unmapped bam files because of missing reference files in the BAM header.

I'm not very familiar with the unittest set up in this repo, so not sure how to add a test case. If anyone could help me with this it would be fantastic.

Closes #97


Test Results

Validation Test

BAM

Case 1 - test type:

  • input file(s):
    path/to/input
    
  • command:
    <command used>
    
  • output:
    path/to/output OR output-message
    

VCF

Case 1 - test:

  • input file(s):
    path/to/input
    
  • command:
    <command used>
    
  • output:
    path/to/output OR output-message
    

Case 2 - test:

  • input file(s):
    path/to/input
    
  • command:
    <command used>
    
  • output:
    path/to/output OR output-message
    

Checksum Test

Case 1 - test:

  • input file(s):
    path/to/input
    
  • command:
    <command used>
    
  • output:
    path/to/output OR output-message
    

Checklist

File Commits

  • This PR does NOT contain Protected Health Information (PHI). A repo may need to be deleted if such data is uploaded.
    Disclosing PHI is a major problem1 - Even a small leak can be costly2.

  • This PR does NOT contain germline genetic data3, RNA-Seq, DNA methylation, microbiome or other molecular data4.

  • This PR does NOT contain other non-plain text files, such as: compressed files, images (e.g. .png, .jpeg), .pdf, .RData, .xlsx, .doc, .ppt, or other output files.

  To automatically exclude such files using a .gitignore file, see here for example.

Code Review Best Practices

  • I have read the code review guidelines and the code review best practice on GitHub check-list.

  • I have set up or verified the main branch protection rule following the github standards before opening this pull request.

  • The name of the branch is meaningful and well formatted following the standards, using [AD_username (or 5 letters of AD if AD is too long)]-[brief_description_of_branch].

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

Testing

  • I have added unit tests for the new feature(s).

  • I modified the integration test(s) to include the new feature.

  • All new and previously existing tests passed locally and/or on the cluster.

  • The docker image built successfully on the cluster.

Footnotes

  1. UCLA Health reaches $7.5m settlement over 2015 breach of 4.5m patient records

  2. The average healthcare data breach costs $2.2 million, despite the majority of breaches releasing fewer than 500 records.

  3. Genetic information is considered PHI.
    Forensic assays can identify patients with as few as 21 SNPs

  4. RNA-Seq, DNA methylation, microbiome, or other molecular data can be used to predict genotypes (PHI) and reveal a patient's identity.

@yashpatel6 yashpatel6 self-assigned this Jun 6, 2024
@yashpatel6 yashpatel6 requested a review from nwiltsie June 25, 2024 01:00
@yashpatel6 yashpatel6 assigned nwiltsie and unassigned yashpatel6 Jun 25, 2024
@nwiltsie
Copy link
Member

I'll get to this today!

Copy link
Member

@nwiltsie nwiltsie 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 to me!

I ran pytest locally to confirm that @yashpatel6's changes still work. We should set up an Action to do so automatically as well.

@yashpatel6
Copy link
Collaborator

Looks good to me!

I ran pytest locally to confirm that @yashpatel6's changes still work. We should set up an Action to do so automatically as well.

Agreed, I think we want to set up a pytest action, we've had some discussion in the software WG around this with running and also generating coverage reports and such

@yashpatel6 yashpatel6 merged commit cc1d3d4 into main Jun 25, 2024
5 checks passed
@yashpatel6 yashpatel6 deleted the czhu-fix-unmapped-bam branch June 25, 2024 20:05
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.

Unmapped BAM
3 participants