I might be being a bit thick but is there a full d...
# multiqcs
Sam Wilkinson
05/14/2025, 9:50 AMI might be being a bit thick but is there a full doc which explains each possible option for
multiqc.ymlp
Phil Ewels
05/14/2025, 10:36 AMFunny you should ask 😅 We have a PR open at the moment to add exactly that: https://github.com/MultiQC/MultiQC/pull/3183
Phil Ewels
05/14/2025, 10:37 AMWe're still playing with how it's rendered, but you can see the current state here: https://github.com/MultiQC/MultiQC/blob/52623eee23203ed209807e348ebce050fb54d851/docs/markdown/config_schema.md
🙌 1
Phil Ewels
05/14/2025, 10:38 AMYou can also see the defaults in this file: https://github.com/MultiQC/MultiQC/blob/main/multiqc/config_defaults.yaml
s
Sam Wilkinson
05/14/2025, 10:38 AMamazing, the only other thing it would be nice to have would be examples as well 🙂
p
Phil Ewels
05/14/2025, 10:39 AMI think that examples for every single config option might be too much for that page - I'm more thinking of having a table view for it or something, so that you can cmd+F your way to a given config option and see a description / type etc. There are hundreds of config options (138 to be specific), so that would be a lot of examples to write..
s
Sam Wilkinson
05/14/2025, 10:40 AMyeah fair enough, that would be lots of work
p
Phil Ewels
05/14/2025, 10:40 AMThat said, it's something that we can try to progressively improve over time
Phil Ewels
05/14/2025, 10:40 AMThere are a couple of things at the end that have examples already
Phil Ewels
05/14/2025, 10:41 AMI was thinking that the existing Configuration docs page you linked to would continue to exist for more use-based / example docs, and the new one above to complement it as reference.
Phil Ewels
05/14/2025, 10:41 AMSo if there's something you're missing in the main docs page then shout and we can add it
👍 1