Examples (old)

Best Practice Examples

BRAT - A New Research-Grade Script

In the case of tools or models that represent novel, new and/or significant methodological advances or scientific contributions, the model should also be vetted in the peer-reviewed scholarly literature. For example, the RC BRAT (Beaver Restoration Assessment Tool) beaver dam capacity model (BRAT) was originally vetted in:

• Macfarlane W.W., Wheaton J.M., Bouwes N., Jensen M., Gilbert J.T., Hough-Snee N., and Shivick J. 2015. Modeling the capacity of riverscapes to support beaver dams. Geomorphology. DOI: 10.1016/j.geomorph.2015.11.019.

Tributary Impact - Implementing a Research Grade Script

By contrast, algorithms and methods that have already been published and vetted, but are simply packaged into an open source tool for others to use should cite the original author
For example, the Tributary Impact was originally vetted and presented in:

• Rice SP. 2017. Tributary connectivity, confluence aggradation and network biodiversity. Geomorphology 277 : 6–16. DOI: 10.1016/j.geomorph.2016.03.027

However, the algorithm was coded up to implement and shared as

• Source code documentation is in its open-source Riverscapes GitHub repo in the Riverscapes: https://github.com/Riverscapes/TributaryImpact
• The tool website at http://tributaryimpact.riverscapes.net/ and is minimally documented for transparency