validating config files description

[kjsato]

In the description of "Validating your config files", we might understand the two config files were validated with one command but actually only one file "tasks.json" had been validated. If it is true, the description should be modified according to the actual behaviour so far.

[mzorn-58]

@lshandross @LucieContamin @annakrystalli @elray1

Does the following code validate both "tasks.json" and "admin.json" or just "tasks.json"?

library(hubUtils)
validate_config(
    hub_path = ".",
    config = c("tasks", "admin"), 
    config_path = NULL, 
    schema_version = "from_config", 
    branch = "main"
)

[lshandross]

Hi @mzorn-58 the documentation for validate_config here seems to suggest that the config argument can only accept a single character string. I'm guessing that if a vector of character strings is provided instead that only the first is used. We should definitely ensure the general hubverse documentation makes this clear and potentially throw an error as well if a character vector is provided instead of a character string.

[LucieContamin]

Hi all,

To add more information:

• @lshandross is correct, the validate_config() validates only one config file, if you provide both in the config parameter, only the first one will be tested.
• the function validate_hub_config() validates all the config files

[mzorn-58]

SO we should change config=c("tasks","admin") to read config = "tasks". And then we could add a note below saying that you you would use validate_hub_config() and config=c("tasks","admin") to validate all config files.

[annakrystalli]

Hi @mzorn-58 validate_hub_config() takes no arguments, it just validates all hub config files in one go.

Also both these functions now live in the hubAdmin package. See function documentation pages for more details including examples of how both functions are used:

• https://infectious-disease-modeling-hubs.github.io/hubAdmin/reference/validate_hub_config.html
• https://infectious-disease-modeling-hubs.github.io/hubAdmin/reference/validate_config.html

[mzorn-58]

@micokoch Is it OK if I work on this Alvaro? I am looking for an issue and I had done some work on this previously.

[micokoch]

Yes, @mzorn-58 - thank you.