Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

• 🎯 correct output
• 🖼️ correct figures
• ❓ new warnings
• ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/epiverse-trace/research-compendium/compare/md-outputs..md-outputs-PR-19

The following changes were observed in the rendered markdown documents:

⏱️ Updated at 2023-11-15 18:54:32 +0000

Hi @jamesmbaazam I identified a conflict between the generated CITATION.cff file for this repo and the expected CITATION file in the workbench template. I generated a solution that involves having both in the root folder. More details are in the associated issue.

Would you be able to review this and share your feedback about the solution proposed in this PR? and evaluate if it is a fair solution to propagate for other workbench repos in the organization?

Hi @jamesmbaazam do you think would be appropriate to have two citation files in the root folder?

• CITATION.cff suitable for GitHub .cff feature to generate bibtex and apa formats (generated from DESCRIPTION file)
• CITATION suitable for workbench template in a human-readable format (generated from CITATION.cff file)

I think that for the moment this can work.

But I can also consider reporting this to {varnish} to redirect to CITATION.cff when available

Hi @avallecam, I think it's fine. We do this in the packages as well but we also use the cff workflow to sync the .cff file with the DESCRIPTION and CITATION files. I think since this is not a package, you can probably delete Line 12 in the workflow.

We do this in the packages as well but we also use the cff workflow to sync the .cff file with the DESCRIPTION and CITATION files

This is informative. Thank you for sharing that workflow. I'll try to add it. This repo generates CITATION file from the DESCRIPTION file, so this should work as expected as in packages.

Oh yes, sorry, I didn't see the DESCRIPTION file when I quickly checked yesterday. You don't need to change anything then.