Skip to content

Improve the documentation in for DIANN + quantms and modules parameters #673

@ypriverol

Description

@ypriverol

In the following PR #660 we add some warning and blocking of parameters of specific params + modules in DIANN. However, this has triggered another issue about the warning messages we are throwing when a parameter not supported by a module is provided.

[modules/local/diann/insilico_library_generation/main.nf](https://github.com/bigbio/quantms/pull/660/files/95277e87473acb7634a1179c72d3ae8cc13ab299#diff-e545d403b6c6355b3378001ec24e1108bee6358ee505c5a70b993395bcc3c6c0)
    blocked.sort { a -> -a.length() }.each { flag ->
        def flagPattern = '(?<=^|\\s)' + java.util.regex.Pattern.quote(flag) + '(?=\\s|\$)(\\s+(?!-{1,2}[a-zA-Z])\\S+)*'
        if (args =~ flagPattern) {
            log.warn "DIA-NN: '${flag}' is managed by the pipeline for INSILICO_LIBRARY_GENERATION and will be stripped."

#660 (comment)

I think the solution is to have a main page in the documentation with all the parameters in DIANN that can be provided to each module and which ones do not make sense; and the reason. We can update the pipeline and warning message pointing to that page.

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions