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 feature-benchmark branch #158

Merged
merged 26 commits into from
Sep 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
416efeb
adding viloca to the workflow
LaraFuhrmann Feb 5, 2024
13aee8e
fix file paths
LaraFuhrmann Feb 6, 2024
7ddb320
update conig_schema
LaraFuhrmann Mar 5, 2024
17f779c
adding paired_end_read_merger
LaraFuhrmann Jun 4, 2024
15d75b3
update rule for paired_en_read_merger + add conda env definition
LaraFuhrmann Jun 5, 2024
c2c2ae7
update rule for paired_en_read_merger + add conda env definition
LaraFuhrmann Jun 5, 2024
5174e9a
update enviroment
LaraFuhrmann Jun 5, 2024
3e79e5e
add paired_end_read_merger
LaraFuhrmann Jun 5, 2024
206e056
update paired_end_read_merger rule
LaraFuhrmann Jun 6, 2024
4ccd9d8
add conda package to env
LaraFuhrmann Jun 6, 2024
2af73f9
Viloca touch ups
DrYak Jun 7, 2024
59386c7
Linting
DrYak Jun 7, 2024
c948d2e
Generate copnfig manual
DrYak Jun 7, 2024
24e1afe
Documentation touch ups
DrYak Jun 7, 2024
bb4af16
improve tutorial_0_install.md
prajwalkulkarni Apr 29, 2024
d840e80
Links to bioconda in installation tutorial
DrYak Jun 7, 2024
b349a51
Singularity+conda support
DrYak Jun 7, 2024
3f3292e
Update README.md with viloca reference
LaraFuhrmann Jun 10, 2024
e8360b8
Add issue templates
DrYak Jun 10, 2024
1f589ad
Contributing guidelines
DrYak Jun 10, 2024
7013890
Disable linter for templates
DrYak Jun 10, 2024
9be30da
bugfix: viloca
DrYak Jun 14, 2024
5befca4
bugfix: bump versions of bcftools and cyvcf2
DrYak Jun 28, 2024
b29c0a5
[bump] LolliPop 0.4.0
DrYak Jul 5, 2024
62df040
Update of conf manual
DrYak Jul 5, 2024
7037675
[bump] LolliPop v0.4.1
DrYak Jul 6, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/01_report_bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: 🐛 Report a bug
about: Tell us if something is broken or needs attention
labels: t:bug, help wanted, good first issue, needs triage
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior, e.g.:
1. V-pipe configuration file used '...'
2. Samples TSV file used '....'
3. Commands executed '.vpipe --core 4 ...'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. Linux, Mac OS]
- Version [e.g. v3.0.0, master branch]

**Additional context**
Add any other context about the problem here.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/02_request_feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: 🙋 Request a feature
about: Suggest an improvement, tell about your idea
labels: t:feat, help wanted, good first issue, needs triage
---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when ...

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/03_ask.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
name: ❓ Ask
about: Ask a question about this project
labels: t:ask, needs triage
---
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/04_discuss.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
name: 💬 Discuss
about: Talk to the team
labels: t:talk, needs triage
---
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
2 changes: 2 additions & 0 deletions .mega-linter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,5 @@ SHOW_ELAPSED_TIME: true
DEFAULT_BRANCH: master
# any further fix to LICENSE.md will break licensee's detection scheme
MARKDOWN_MARKDOWNLINT_FILTER_REGEX_EXCLUDE: LICENSE\.md
# GitHub passes HTML comments verbatime from template so we can't use <!-- markdownlint-disable MD041 -->
FILTER_REGEX_EXCLUDE: (\.github/ISSUE_TEMPLATE/.*\.md)
2 changes: 1 addition & 1 deletion .snakemake-workflow-catalog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ usage:
software-stack-deployment:
conda: true
singularity: false
singularity+conda: false
singularity+conda: true
report: false
57 changes: 57 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@

# Contributing to V-pipe

A big welcome and thank you for considering contributing to V-pipe! It’s people like you that make it a reality for users in our community.

Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests.

## Quicklinks

* [Getting Started](#getting-started)
* [Issues](#issues)
* [Pull Requests](#pull-requests)
* [Getting Help](#getting-help)

## Getting Started

Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both:

- Search for existing Issues and PRs before creating your own.
- We work hard to makes sure issues are handled in a timely manner but, depending on the impact, it could take a while to investigate the root cause. A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking.

### Issues

Issues should be used to report problems with the V-pipe workflow, request a new feature, or to discuss potential changes before a PR is created. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the information we need to investigate.

If you find an Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one. Adding a [reaction](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) can also help be indicating to our maintainers that a particular problem is affecting more than just the reporter.

### Pull Requests

PRs to our workflow are always welcome and can be a quick way to get your fix or improvement slated for the next release. In general, PRs should:

- Target our staging branch: [rubicon](https://github.com/cbg-ethz/V-pipe/tree/rubicon)
- Only fix/add the functionality in question **OR** address wide-spread whitespace/style issues, not both.
- Add unit or integration tests for fixed or changed functionality (if a test suite already exists).
- Or at least provide a minimalist example dataset
- Address a single concern in the least number of changed lines as possible.
- Include documentation in the repo or on our `docs/` directory.

For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.

In general, we follow the ["fork-and-pull" Git workflow](https://github.com/susam/gitpr)

1. Fork the repository to your own Github account
2. Clone the project to your machine
3. Create a branch locally with a succinct but descriptive name
4. Commit changes to the branch
5. Following any formatting and testing guidelines specific to this repo
- We rely on [snakefmt](https://github.com/snakemake/snakefmt) for Snakemake files
- We use [Mega-Linter](https://megalinter.io) for the remaining files (Python (Black), Jupyter (Jupyfmt), Markdown (Markdownlint), Bash (Shellcheck), Perl (Perlcritic), Docker (Hadolint))
- Ask us for help if you have trouble linting your code
6. Push changes to your fork
7. Open a PR in our repository and follow the PR template so that we can efficiently review the changes.

## Getting Help

Join us in the [V-pipe Gitter channel](https://gitter.im/V-pipe/community) (also [accessible over matrix](https://matrix.to/#/#V-pipe_community:gitter.im?utm_source=gitter) from your favorite client) and post your question there to reach out the devs.
For further inquiries, you can also contact the V-pipe Dev Team by opening a ticket at [[email protected]](mailto:[email protected]).
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,9 +162,9 @@ Other dependencies are managed by using isolated conda environments per rule, an

If you use this software in your research, please cite:

Posada-Céspedes S., Seifert D., Topolsky I., Jablonski K.P., Metzner K.J., and Beerenwinkel N. 2021.
"V-pipe: a computational pipeline for assessing viral genetic diversity from high-throughput sequencing data."
_Bioinformatics_, January. doi:[10.1093/bioinformatics/btab015](https://doi.org/10.1093/bioinformatics/btab015).
Fuhrmann, L., Jablonski, K. P., Topolsky, I., Batavia, A. A., Borgsmueller, N., Icer Baykal, P., Carrara, M. ... & Beerenwinkel, (2023).
"V-Pipe 3.0: A Sustainable Pipeline for Within-Sample Viral Genetic Diversity Estimation."
_bioRxiv_, doi:[10.1101/2023.10.16.562462](https://doi.org/10.1101/2023.10.16.562462).

## Contributions

Expand Down
Loading
Loading