nf-core / seqinspector

QC pipeline to inspect your sequences
https://nf-co.re/seqinspector
MIT License
7 stars 21 forks source link

add fq lint #57

Closed erkutilaslan closed 1 week ago

erkutilaslan commented 3 weeks ago

added barebones fq/lint module to the pipeline. looking for feedback to how to implement it.

PR checklist

github-actions[bot] commented 3 weeks ago

nf-core pipelines lint overall result: Passed :white_check_mark: :warning:

Posted for pipeline commit 2b75934

+| ✅ 191 tests passed       |+
#| ❔   1 tests were ignored |#
!| ❗  21 tests had warnings |!
### :heavy_exclamation_mark: Test warnings: * [readme](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/readme) - README contains the placeholder `zenodo.XXXXXXX`. This should be replaced with the zenodo doi (after the first release). * [pipeline_todos](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/pipeline_todos) - TODO string in `main.nf`: _Remove this line if you don't need a FASTA file_ * [pipeline_todos](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/pipeline_todos) - TODO string in `nextflow.config`: _Specify your pipeline's command line flags_ * [pipeline_todos](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/pipeline_todos) - TODO string in `nextflow.config`: _Optionally, you can add a pipeline-specific nf-core config at https://github.com/nf-core/configs_ * [pipeline_todos](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/pipeline_todos) - TODO string in `README.md`: _TODO nf-core:_ * [pipeline_todos](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/pipeline_todos) - TODO string in `README.md`: _Include a figure that guides the user through the major workflow steps. Many nf-core_ * [pipeline_todos](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/pipeline_todos) - TODO string in `README.md`: _Fill in short bullet-pointed list of the default steps in the pipeline_ * [pipeline_todos](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/pipeline_todos) - TODO string in `README.md`: _Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file._ * [pipeline_todos](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/pipeline_todos) - TODO string in `README.md`: _Add bibliography of tools and data used in your pipeline_ * [pipeline_todos](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/pipeline_todos) - TODO string in `usage.md`: _Add documentation about anything specific to running your pipeline. For general topics, please point to (and add to) the main nf-core website._ * [pipeline_todos](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/pipeline_todos) - TODO string in `main.nf`: _Optionally add in-text citation tools to this list._ * [pipeline_todos](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/pipeline_todos) - TODO string in `main.nf`: _Optionally add bibliographic entries to this list._ * [pipeline_todos](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/pipeline_todos) - TODO string in `main.nf`: _Only uncomment below if logic in toolCitationText/toolBibliographyText has been filled!_ * [pipeline_todos](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/pipeline_todos) - TODO string in `test_full.config`: _Specify the paths to your full test data ( on nf-core/test-datasets or directly in repositories, e.g. SRA)_ * [pipeline_todos](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/pipeline_todos) - TODO string in `test_full.config`: _Give any required params for the test so that command line flags are not needed_ * [pipeline_todos](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/pipeline_todos) - TODO string in `test.config`: _Specify the paths to your test data on nf-core/test-datasets_ * [pipeline_todos](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/pipeline_todos) - TODO string in `test.config`: _Give any required params for the test so that command line flags are not needed_ * [pipeline_todos](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/pipeline_todos) - TODO string in `base.config`: _Check the defaults for all processes_ * [pipeline_todos](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/pipeline_todos) - TODO string in `base.config`: _Customise requirements for specific processes._ * [pipeline_todos](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/pipeline_todos) - TODO string in `methods_description_template.yml`: _#Update the HTML below to your preferred methods description, e.g. add publication citation for this pipeline_ * [pipeline_todos](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/pipeline_todos) - TODO string in `awsfulltest.yml`: _You can customise AWS full pipeline tests as required_ ### :grey_question: Tests ignored: * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - File ignored due to lint config: `.github/CONTRIBUTING.md` ### :white_check_mark: Tests passed: * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `.gitattributes` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `.gitignore` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `.nf-core.yml` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `.editorconfig` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `.prettierignore` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `.prettierrc.yml` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `CHANGELOG.md` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `CITATIONS.md` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `CODE_OF_CONDUCT.md` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `LICENSE` or `LICENSE.md` or `LICENCE` or `LICENCE.md` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `nextflow_schema.json` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `nextflow.config` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `README.md` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `.github/.dockstore.yml` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `.github/CONTRIBUTING.md` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `.github/ISSUE_TEMPLATE/bug_report.yml` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `.github/ISSUE_TEMPLATE/config.yml` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `.github/ISSUE_TEMPLATE/feature_request.yml` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `.github/PULL_REQUEST_TEMPLATE.md` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `.github/workflows/branch.yml` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `.github/workflows/ci.yml` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `.github/workflows/linting_comment.yml` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `.github/workflows/linting.yml` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `assets/email_template.html` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `assets/email_template.txt` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `assets/sendmail_template.txt` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `assets/nf-core-seqinspector_logo_light.png` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `conf/modules.config` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `conf/test.config` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `conf/test_full.config` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `docs/images/nf-core-seqinspector_logo_light.png` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `docs/images/nf-core-seqinspector_logo_dark.png` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `docs/output.md` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `docs/README.md` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `docs/README.md` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `docs/usage.md` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `main.nf` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `assets/multiqc_config.yml` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `conf/base.config` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `conf/igenomes.config` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `conf/igenomes_ignored.config` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `.github/workflows/awstest.yml` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `.github/workflows/awsfulltest.yml` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File found: `modules.json` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File not found check: `.github/ISSUE_TEMPLATE/bug_report.md` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File not found check: `.github/ISSUE_TEMPLATE/feature_request.md` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File not found check: `.github/workflows/push_dockerhub.yml` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File not found check: `.markdownlint.yml` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File not found check: `.nf-core.yaml` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File not found check: `.yamllint.yml` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File not found check: `bin/markdown_to_html.r` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File not found check: `conf/aws.config` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File not found check: `docs/images/nf-core-seqinspector_logo.png` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File not found check: `lib/Checks.groovy` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File not found check: `lib/Completion.groovy` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File not found check: `lib/NfcoreTemplate.groovy` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File not found check: `lib/Utils.groovy` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File not found check: `lib/Workflow.groovy` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File not found check: `lib/WorkflowMain.groovy` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File not found check: `lib/WorkflowSeqinspector.groovy` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File not found check: `parameters.settings.json` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File not found check: `pipeline_template.yml` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File not found check: `Singularity` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File not found check: `lib/nfcore_external_java_deps.jar` * [files_exist](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_exist) - File not found check: `.travis.yml` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Found nf-schema plugin * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `manifest.name` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `manifest.nextflowVersion` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `manifest.description` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `manifest.version` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `manifest.homePage` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `timeline.enabled` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `trace.enabled` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `report.enabled` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `dag.enabled` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `process.cpus` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `process.memory` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `process.time` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `params.outdir` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `params.input` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `validation.help.enabled` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `manifest.mainScript` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `timeline.file` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `trace.file` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `report.file` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `dag.file` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `validation.help.beforeText` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `validation.help.afterText` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `validation.help.command` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `validation.summary.beforeText` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable found: `validation.summary.afterText` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable (correctly) not found: `params.nf_required_version` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable (correctly) not found: `params.container` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable (correctly) not found: `params.singleEnd` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable (correctly) not found: `params.igenomesIgnore` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable (correctly) not found: `params.name` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable (correctly) not found: `params.enable_conda` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable (correctly) not found: `params.max_cpus` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable (correctly) not found: `params.max_memory` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable (correctly) not found: `params.max_time` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable (correctly) not found: `params.validationFailUnrecognisedParams` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable (correctly) not found: `params.validationLenientMode` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable (correctly) not found: `params.validationSchemaIgnoreParams` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable (correctly) not found: `params.validationShowHiddenParams` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config ``timeline.enabled`` had correct value: ``true`` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config ``report.enabled`` had correct value: ``true`` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config ``trace.enabled`` had correct value: ``true`` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config ``dag.enabled`` had correct value: ``true`` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config ``manifest.name`` began with ``nf-core/`` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable ``manifest.homePage`` began with https://github.com/nf-core/ * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config ``dag.file`` ended with ``.html`` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config variable ``manifest.nextflowVersion`` started with >= or !>= * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config ``manifest.version`` ends in ``dev``: ``1.0dev`` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config `params.custom_config_version` is set to `master` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config `params.custom_config_base` is set to `https://raw.githubusercontent.com/nf-core/configs/master` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Lines for loading custom profiles found * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - nextflow.config contains configuration profile `test` * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config default value correct: params.sample_size= 0 * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config default value correct: params.igenomes_base= s3://ngi-igenomes/igenomes/ * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config default value correct: params.custom_config_version= master * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config default value correct: params.custom_config_base= https://raw.githubusercontent.com/nf-core/configs/master * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config default value correct: params.publish_dir_mode= copy * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config default value correct: params.max_multiqc_email_size= 25.MB * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config default value correct: params.validate_params= true * [nextflow_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nextflow_config) - Config default value correct: params.pipelines_testdata_base_path= https://raw.githubusercontent.com/nf-core/test-datasets/ * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - `.gitattributes` matches the template * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - `.prettierrc.yml` matches the template * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - `CODE_OF_CONDUCT.md` matches the template * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - `LICENSE` matches the template * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - `.github/.dockstore.yml` matches the template * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - `.github/ISSUE_TEMPLATE/bug_report.yml` matches the template * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - `.github/ISSUE_TEMPLATE/config.yml` matches the template * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - `.github/ISSUE_TEMPLATE/feature_request.yml` matches the template * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - `.github/PULL_REQUEST_TEMPLATE.md` matches the template * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - `.github/workflows/branch.yml` matches the template * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - `.github/workflows/linting_comment.yml` matches the template * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - `.github/workflows/linting.yml` matches the template * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - `assets/email_template.html` matches the template * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - `assets/email_template.txt` matches the template * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - `assets/sendmail_template.txt` matches the template * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - `assets/nf-core-seqinspector_logo_light.png` matches the template * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - `docs/images/nf-core-seqinspector_logo_light.png` matches the template * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - `docs/images/nf-core-seqinspector_logo_dark.png` matches the template * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - `docs/README.md` matches the template * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - `.gitignore` matches the template * [files_unchanged](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/files_unchanged) - `.prettierignore` matches the template * [actions_ci](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/actions_ci) - '.github/workflows/ci.yml' is triggered on expected events * [actions_ci](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/actions_ci) - '.github/workflows/ci.yml' checks minimum NF version * [actions_awstest](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/actions_awstest) - '.github/workflows/awstest.yml' is triggered correctly * [actions_awsfulltest](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/actions_awsfulltest) - `.github/workflows/awsfulltest.yml` is triggered correctly * [actions_awsfulltest](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/actions_awsfulltest) - `.github/workflows/awsfulltest.yml` does not use `-profile test` * [readme](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/readme) - README Nextflow minimum version badge matched config. Badge: `24.04.2`, Config: `24.04.2` * [plugin_includes](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/plugin_includes) - No wrong validation plugin imports have been found * [pipeline_name_conventions](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/pipeline_name_conventions) - Name adheres to nf-core convention * [template_strings](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/template_strings) - Did not find any Jinja template strings (0 files) * [schema_lint](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/schema_lint) - Schema lint passed * [schema_lint](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/schema_lint) - Schema title + description lint passed * [schema_lint](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/schema_lint) - Input mimetype lint passed: 'text/csv' * [schema_params](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/schema_params) - Schema matched params returned from nextflow config * [system_exit](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/system_exit) - No `System.exit` calls found * [actions_schema_validation](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/actions_schema_validation) - Workflow validation passed: nf-test.yml * [actions_schema_validation](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/actions_schema_validation) - Workflow validation passed: linting.yml * [actions_schema_validation](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/actions_schema_validation) - Workflow validation passed: branch.yml * [actions_schema_validation](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/actions_schema_validation) - Workflow validation passed: fix-linting.yml * [actions_schema_validation](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/actions_schema_validation) - Workflow validation passed: release-announcements.yml * [actions_schema_validation](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/actions_schema_validation) - Workflow validation passed: awsfulltest.yml * [actions_schema_validation](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/actions_schema_validation) - Workflow validation passed: template_version_comment.yml * [actions_schema_validation](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/actions_schema_validation) - Workflow validation passed: download_pipeline.yml * [actions_schema_validation](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/actions_schema_validation) - Workflow validation passed: ci.yml * [actions_schema_validation](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/actions_schema_validation) - Workflow validation passed: clean-up.yml * [actions_schema_validation](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/actions_schema_validation) - Workflow validation passed: awstest.yml * [actions_schema_validation](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/actions_schema_validation) - Workflow validation passed: linting_comment.yml * [merge_markers](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/merge_markers) - No merge markers found in pipeline files * [modules_json](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/modules_json) - Only installed modules found in `modules.json` * [multiqc_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/multiqc_config) - `assets/multiqc_config.yml` found and not ignored. * [multiqc_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/multiqc_config) - `assets/multiqc_config.yml` contains `report_section_order` * [multiqc_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/multiqc_config) - `assets/multiqc_config.yml` contains `export_plots` * [multiqc_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/multiqc_config) - `assets/multiqc_config.yml` contains `report_comment` * [multiqc_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/multiqc_config) - `assets/multiqc_config.yml` follows the ordering scheme of the minimally required plugins. * [multiqc_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/multiqc_config) - `assets/multiqc_config.yml` contains a matching 'report_comment'. * [multiqc_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/multiqc_config) - `assets/multiqc_config.yml` contains 'export_plots: true'. * [modules_structure](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/modules_structure) - modules directory structure is correct 'modules/nf-core/TOOL/SUBTOOL' * [base_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/base_config) - `conf/base.config` found and not ignored. * [modules_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/modules_config) - `conf/modules.config` found and not ignored. * [modules_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/modules_config) - `SEQTK_SAMPLE` found in `conf/modules.config` and Nextflow scripts. * [modules_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/modules_config) - `FASTQC` found in `conf/modules.config` and Nextflow scripts. * [modules_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/modules_config) - `FQ_LINT` found in `conf/modules.config` and Nextflow scripts. * [modules_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/modules_config) - `MULTIQC_GLOBAL` found in `conf/modules.config` and Nextflow scripts. * [modules_config](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/modules_config) - `MULTIQC_PER_TAG` found in `conf/modules.config` and Nextflow scripts. * [nfcore_yml](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nfcore_yml) - Repository type in `.nf-core.yml` is valid: `pipeline` * [nfcore_yml](https://nf-co.re/tools/docs/3.0.2/pipeline_lint_tests/nfcore_yml) - nf-core version in `.nf-core.yml` is set to the latest version: `3.0.2` ### Run details * nf-core/tools version 3.0.2 * Run at `2024-10-30 11:17:23`
ctuni commented 3 weeks ago

I see that the fq tool by default exits with an error if linting issues are found. I think that the way of using it in the pipeline should be instead to use the --lint-mode log ext.args always. That way the errors are logged and the user can read them instead of having the pipeline fail and exit if issues are found in the validation of FASTQ files.

By adding this to the conf/modules.config:

    withName: FQ_LINT {
        ext.args = '--lint-mode log'
    }
sarahjeeeze commented 3 weeks ago

Do you need to update the README.md

erkutilaslan commented 3 weeks ago

Thanks a lot for the comments and suggestions! I have a question regarding the publishDir. The conf/modules.config contains the following:

    publishDir = [
        path: { "${params.outdir}/${task.process.tokenize(':')[-1].tokenize('_')[0].toLowerCase()}" },
        mode: params.publish_dir_mode,
        saveAs: { filename -> filename.equals('versions.yml') ? null : filename }
    ]

Which creates a publishDir for fq/lint output. Should I still define the publishDir for the module separately as suggested? If so if someone can explain the logic of the above part I would be grateful :)

erkutilaslan commented 1 week ago

closing this PR. fq lint is being implemented under PR #67 .