REPOSITORY NAME

ℹ️ The language badges above (created using Shields.io) link to the README files, to be maintained in both English (README.md) and French (README_FR.md). See instructions (👉 in italics) and example content provided under each section header below. The format of the README template has been designed such that, in most use cases, only the About and Credits sections need be replaced by the user and customized to their projects, keeping all other sections as is. However, the format may be changed/adapted as needed, provided the content under sections indicated as required are included. For instance, if the combined content is brief, the four sections - Credits, Citation, Contribution, and References - may be consolidated into a single section titled Acknowledgements.

ℹ️ Refer Quick Start Guide.

---

Table of Contents

👉 OPTIONAL: The Table of Contents (TOC) may be omitted if the overall content is brief. The TOC can be easily autogenerated, for example, by running command Create Table of Contents in the VSCode extension Markdown All in One. To exclude a heading from appearing in the autogenerated TOC, add <!-- omit in toc --> at the end of that heading or just above it. The TOC will be auto-updated whenever the file is saved after heading changes.

• About
• Documentation
• Credits
• Citation
• Contribution
• References
• Security
• License

---

About

👉 REQUIRED: Provide a summary, purpose, and key features of the project.

This repository serves as a template for creating reproducible and customizable data processing workflows. It is designed to help researchers and developers quickly set up new projects by providing modular and parameterized components that can be easily adapted to different use cases. The template may be customized, adding/removing sections as needed, while maintaining good documentation.

---

Documentation

👉 REQUIRED: All technical documentation should be kept separate from the README, ideally in a dedicated docs folder. Technical documents may be maintained in either English or French. See /docs/user-guide.md for a user guide template. Where resources allow and demand exists, the technical documentation may be maintained in both languages, in which case, those may even be incorporated into the respective READMEs.

For technical details, including installation and usage instructions, please refer to the User Guide.

---

Credits

👉 REQUIRED: Acknowledge all contributors and collaborators, and disclose any use of AI-generated content where applicable. If a detailed breakdown of individual contributions is needed, use a CREDITS.md file to keep the README concise.

This template was developed by the ABCC project team. For a list of individual contributions, see CREDITS.md.

The following files were adapted from the Template for Government of Canada open source code repositories: CODE_OF_CONDUCT.md, CONTRIBUTING.md and SECURITY.md.

🤖 Generative AI models were used in the development of this project, and all AI-generated content has been reviewed, verified, and refined by the project team to ensure accuracy.

---

Citation

👉 REQUIRED: Include citation instructions, ideally via a CITATION.cff file, which enables GitHub and tools like Zenodo to generate standardized citations automatically. See links for the documentation on Citation File Format (CFF) and a tool to generate a custom CITATION.cff file.

To cite this project, click the Cite this repository button on the right-hand sidebar.

---

Contribution

👉 OPTIONAL: Provide guidelines for contributing to the project, if applicable.

Contributions are welcome! Please review the guidelines in CONTRIBUTING.md and ensure you adhere to our CODE_OF_CONDUCT.md to foster a respectful and inclusive environment.

---

References

👉 OPTIONAL: If applicable, provide references to key resources (publications, tools, software). Use a REFERENCES.md file to keep README concise.

For a list of key resources used here, see REFERENCES.md.

---

Security

👉 REQUIRED: Keep as is.

⚠️ Do not post any security issues on the public repository! Please report them as described in SECURITY.md.

---

License

👉 REQUIRED: Helpful resources to understand and select the right license include LicenseHub (see their Smart License Recommendation and License Template Generator tools) and tl;drLegal. An R Shiny tool, OSSLicensR, is also available (internal access only) to guide selection of an appropriate license. If your project does not use the default MIT license provided here, please replace the LICENSE file. Be sure to include the copyright statement both in this section (for visibility) and within the LICENSE file.

See the LICENSE file for details. Visit LicenseHub or tl;drLegal to view a plain-language summary of this license.

Copyright © His Majesty the King in Right of Canada, as represented by the Minister of Agriculture and Agri-Food, 2025.

---