README.md

In OB7-IRD/t3: Tropical Tuna Treatment

t3 package

Tropical Tunas Treatment

Warning

Package and documentation still in construction ! We need few more time to reach 88 miles per hours, be patient.

Overview

The new version of Tropical Tuna Treatment (T3) process is developed in R language and available through a package. One of the advantages of this language is that it is more understandable and manipulated by the fisheries’ scientific community rather than Java language. Moreover, this development follows the principles of the open and reproducible science:

• Process transparency: the code is fully documented and the documentation of how works the program will be available.
• Open access and Open source: the code source is hosted on a github repository t3 under a GPL version 3 license. In the end, it would be available on the Comprehensive R Archive Network (CRAN).
• Referencing of the software : enable result reproducibility and versioning (Depetris et al., 2020) : version 0.9.0 - DOI: 10.5281/zenodo.3878125.

Installation

devtools::install_github("https://github.com/OB7-IRD/t3",
                         INSTALL_opts=c("--no-multiarch"))

Development version

To get a bug fix or to use a feature from the development version, you can install the development version of t3 from GitHub.

devtools::install_github("https://github.com/OB7-IRD/t3",
                         ref = "development",
                         INSTALL_opts=c("--no-multiarch"))

Cheatsheet

Working in progress for this section. Be patient.

Usage

library(t3)
# Next steps example will be added later

Getting help

If you encounter a clear bug, please file an issue with a minimal reproducible example on GitHub issues page. This link is also available if you have any questions and improvement propositions.

References

Working in progress for this section.

OB7-IRD/t3 documentation built on April 23, 2023, 7:34 p.m.