Skip to content

Remove non-standard ext keys and model after quartonotebook#10886

Merged
SPPearce merged 3 commits intonf-core:masterfrom
mahesh-panchal:fix/rmarkdownnotebook-exp-compliance
Mar 19, 2026
Merged

Remove non-standard ext keys and model after quartonotebook#10886
SPPearce merged 3 commits intonf-core:masterfrom
mahesh-panchal:fix/rmarkdownnotebook-exp-compliance

Conversation

@mahesh-panchal
Copy link
Member

@mahesh-panchal mahesh-panchal commented Mar 13, 2026

PR checklist

Part of #8716

  • Removes non-standard ext keys. Inputs should come in through inputs and can override default settings.
  • Reports are always parameterized as a result.
  • Follows the model of QUARTONOTEBOOK.
  • Fixes bug with being able to override the artifacts directory.

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the module conventions in the contribution docs
  • If necessary, include test data in your PR.
  • Remove all TODO statements.
  • Broadcast software version numbers to topic: versions - See version_topics
  • Follow the naming conventions.
  • Follow the parameters requirements.
  • Follow the input/output options guidelines.
  • Add a resource label
  • Use BioConda and BioContainers if possible to fulfil software requirements.
  • Ensure that the test works with either Docker / Singularity. Conda CI tests can be quite flaky:
    • For modules:
      • nf-core modules test <MODULE> --profile docker
      • nf-core modules test <MODULE> --profile singularity
      • nf-core modules test <MODULE> --profile conda
    • For subworkflows:
      • nf-core subworkflows test <SUBWORKFLOW> --profile docker
      • nf-core subworkflows test <SUBWORKFLOW> --profile singularity
      • nf-core subworkflows test <SUBWORKFLOW> --profile conda

Copy link
Contributor

@SPPearce SPPearce left a comment

Choose a reason for hiding this comment

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

@mahesh-panchal , I don't really understand what this module is actually doing inside.
Have you checked that the output file is indeed rendered properly?

@mahesh-panchal
Copy link
Member Author

Rendered output:
test_rmd.html

The code is changed so that it's always reading from a params.yml.
By passing a map in through parameters, one can change implicit parameters, and add new ones. It's also coded such that the parameters are written to the script so a user can see in the .sh file what gets written to the params.yml. The rest of the R code is what was already there. Only the indentation has been removed.

@mahesh-panchal
Copy link
Member Author

There was also an issue where the artifacts directory was mutable but it was hard coded, so there was a decision to make - either make artifacts immutable or mutable, and went with mutable, although the code looks cleaner when it's immutable.

@SPPearce
Copy link
Contributor

I think it would be better to just hardcode the artifacts folder.

@mahesh-panchal mahesh-panchal force-pushed the fix/rmarkdownnotebook-exp-compliance branch from d4c88a2 to f96c67d Compare March 18, 2026 12:30
@mahesh-panchal mahesh-panchal requested a review from SPPearce March 18, 2026 14:35
@SPPearce SPPearce added this pull request to the merge queue Mar 19, 2026
Merged via the queue into nf-core:master with commit 862145b Mar 19, 2026
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants