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.

Sign up for GitHub

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

Jump to bottom

Update doc regarding bwa_index #725

Merged
merged 7 commits into from
Apr 25, 2021
Merged

Update doc regarding bwa_index #725

merged 7 commits into from
Apr 25, 2021

Conversation

maxibor
Copy link
Member

@maxibor maxibor commented Apr 19, 2021

--bwa_index needs to be a directory path, not a filepath

PR checklist

  • This comment contains a description of changes (with reason).
  • Usage Documentation in docs/usage.md is updated.

@maxibor maxibor requested a review from jfy133 April 19, 2021 12:54
@jfy133 jfy133 linked an issue Apr 19, 2021 that may be closed by this pull request
--bwa_index help message confusing #724
Closed
@github-actions
Copy link

github-actions bot commented Apr 19, 2021 •
edited
Loading

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 5fa6e53

+| ✅ 190 tests passed       |+
#| ❔   4 tests were ignored |#
!| ❗  23 tests had warnings |!

❗ Test warnings:

  • conda_env_yaml - Conda dep outdated: conda-forge::python=3.7.3, 3.9.2 available
  • conda_env_yaml - Conda dep outdated: conda-forge::markdown=3.2.2, 3.3.4 available
  • conda_env_yaml - Conda dep outdated: conda-forge::pymdown-extensions=7.1, 8.1.1 available
  • conda_env_yaml - Conda dep outdated: conda-forge::pygments=2.6.1, 2.8.1 available
  • conda_env_yaml - Conda dep outdated: conda-forge::openjdk=8.0.144, 11.0.9.1 available
  • conda_env_yaml - Conda dep outdated: bioconda::adapterremoval=2.3.1, 2.3.2 available
  • conda_env_yaml - Conda dep outdated: bioconda::picard=2.22.9, 2.25.2 available
  • conda_env_yaml - Conda dep outdated: bioconda::samtools=1.9, 1.12 available
  • conda_env_yaml - Conda dep outdated: bioconda::angsd=0.933, 0.935 available
  • conda_env_yaml - Conda dep outdated: bioconda::gatk4=4.1.7.0, 4.2.0.0 available
  • conda_env_yaml - Conda dep outdated: bioconda::gatk=3.5, 3.8 available
  • conda_env_yaml - Conda dep outdated: bioconda::damageprofiler=0.4.9, 1.1 available
  • conda_env_yaml - Conda dep outdated: bioconda::bedtools=2.29.2, 2.30.0 available
  • conda_env_yaml - Conda dep outdated: conda-forge::libiconv=1.15, 1.16 available
  • conda_env_yaml - Conda dep outdated: bioconda::preseq=2.0.3, 3.1.2 available
  • conda_env_yaml - Conda dep outdated: bioconda::bamutil=1.0.14, 1.0.15 available
  • conda_env_yaml - Conda dep outdated: bioconda::pysam=0.15.4, 0.16.0 available
  • conda_env_yaml - Conda dep outdated: conda-forge::pandas=1.0.4, 1.2.4 available
  • conda_env_yaml - Conda dep outdated: bioconda::freebayes=1.3.2, 1.3.5 available
  • conda_env_yaml - Conda dep outdated: conda-forge::biopython=1.76, 1.78 available
  • conda_env_yaml - Conda dep outdated: conda-forge::xopen=0.9.0, 1.1.0 available
  • conda_env_yaml - Conda dep outdated: bioconda::mapdamage2=2.2.0, 2.2.1 available
  • conda_env_yaml - Conda dep outdated: bioconda::bbmap=38.87, 38.90 available

❔ Tests ignored:

  • files_unchanged - File ignored due to lint config: .github/CONTRIBUTING.md
  • files_unchanged - File ignored due to lint config: .github/ISSUE_TEMPLATE/bug_report.md
  • files_unchanged - File ignored due to lint config: docs/README.md
  • files_unchanged - File ignored due to lint config: assets/multiqc_config.yaml

✅ Tests passed:

Run details

  • nf-core/tools version 1.13.3
  • Run at 2021-04-25 14:48:21

jfy133
jfy133 reviewed Apr 19, 2021
View reviewed changes
Copy link
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

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

Is that any clearer?

nextflow_schema.json Outdated Show resolved Hide resolved
@maxibor @jfy133
Update nextflow_schema.json
7fe1501 
Co-authored-by: James A. Fellows Yates <[email protected]>
jfy133
jfy133 approved these changes Apr 19, 2021
View reviewed changes
Copy link
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

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

Please update CHANGELOG and GTG

@github-actions
Copy link

Markdown linting is failing

To keep the code consistent with lots of contributors, we run automated code consistency checks.
To fix this CI test, please run:

  • Install markdownlint-cli
  • Fix the markdown errors
    • Automatically: markdownlint . --config .github/markdownlint.yml --fix
    • Manually resolve anything left from markdownlint . --config .github/markdownlint.yml

Once you push these changes the test should pass, and you can hide this comment 👍

We highly recommend setting up markdownlint in your code editor so that this formatting is done automatically on save. Ask about it on Slack for help!

Thanks again for your contribution!

1 similar comment
@github-actions
Copy link

Markdown linting is failing

To keep the code consistent with lots of contributors, we run automated code consistency checks.
To fix this CI test, please run:

  • Install markdownlint-cli
  • Fix the markdown errors
    • Automatically: markdownlint . --config .github/markdownlint.yml --fix
    • Manually resolve anything left from markdownlint . --config .github/markdownlint.yml

Once you push these changes the test should pass, and you can hide this comment 👍

We highly recommend setting up markdownlint in your code editor so that this formatting is done automatically on save. Ask about it on Slack for help!

Thanks again for your contribution!

@jfy133 jfy133 merged commit f1577ab into dev Apr 25, 2021
@jfy133 jfy133 deleted the minor-doc-update branch April 25, 2021 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jfy133 jfy133 jfy133 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

--bwa_index help message confusing
2 participants
@maxibor @jfy133