SIT-design project deliverable
1 Introduction
This document summarises and provides links to the final reports and products of the project at the time of its delivery.
2 Project summary
The commission consisted in the development of a R-package that replicated the calculations performed in a provided Excel sheet MRR_template.xls.
A companion document with details about the calculations was provided.
3 Project execution
The first stage of the project consisted on a requirements analysis and resulted in the following report.
This stage took an unforeseen amount of time due to:
difficulties related to necessary generalisations of the very particular case study provided in the template (e.g. concerning line releases, different release points, multiple species, possibility of adult traps in a control area, etc.)
lack of references and sufficient details in the documentation
concerns about the appropriateness of the proposed procedures under certain circumstances (competitiveness, flight range),
necessity of carefully revising, rethinking, proposing and validating alternatives to several procedures
This prolonged by a factor of 5 the time planned for this stage.
The subsequent stages (Programming, Testing and Documentation) were executed in parallel. Although they are not completely finished, a preliminary version of the product is available (see next section).
Package name. The commissioners and I agreed on the name
sit.A professional illustrator designed a logo which was validated by the commissioners amongst other prototypes.
4 Documentation on the design project
The complete documentation of the design project, including the present report are publicly available at https://forgemia.inra.fr/umr-astre/sit-design/.
A log of the questions, subsequent discussions and solutions given can also be found in the same platform at https://forgemia.inra.fr/umr-astre/sit-design/-/issues.
Some of the issues are still open at the moment.
5 R-package and documentation
The main product delivered as the project outcome is the R-package itself and associated documentation.
The source code of package is publicly hosted on line in a GitLab repository at https://forgemia.inra.fr/umr-astre/sit.
A web site for the package was made available at https://umr-astre.pages.mia.inra.fr/sit. It provides access to the code source, an overview, installation instructions, all the documentation, testing results and coverage reports.
All contents in the web site are automatically updated at each update of the source code. Little intervention is required to keep it up to date, other than occasional fixes due to changes in the ecosystem of R-packages.
A user mailing list for support and announcements has been set up with the commitment to provide reasonable assistance for an indefinite period.
A bug-tracking system has been opened for reporting and tracking issues and feature-requests.