Commit d9685110 authored by Facundo Muñoz's avatar Facundo Muñoz ®️
Browse files

Update deliverable.

parent 001b4d13
......@@ -5,12 +5,17 @@ Requirements and design of a R package for analysing data from Mark-Capture-Reca
The _Sterile Insect Technique_ (SIT) is being developed by the _Insect Pest Control Laboratory_ (IPCL) of the Joint FAO/IAEA _Centre of Nuclear Techniques in Food and Agriculture_ in Vienna, Austria.
### Documents
- [Project plan](https://umr-astre.pages.mia.inra.fr/sit-design/devtime_estimates.html)
- [Analysis of requirements](https://umr-astre.pages.mia.inra.fr/sit-design/requirements.html)
- [Project deliverable](https://umr-astre.pages.mia.inra.fr/sit-design/deliverable.html)
### Products
- [Package development repository](https://forgemia.inra.fr/umr-astre/sit)
- [Package web site](https://forgemia.inra.fr/umr-astre/sit)
- [Package web site](https://umr-astre.pages.mia.inra.fr/sit)
......@@ -42,38 +42,67 @@ The commission consisted in the development of a R-package that replicated the c
A companion document with details about the calculations was provided.
- [Project Plan](https://umr-astre.pages.mia.inra.fr/sit-design/plan.html)
- [Project Plan](https://umr-astre.pages.mia.inra.fr/sit-design/devtime_estimates.html)
# Project execution
The first stage of the project consisted on a _requirements analysis_ and resulted in the following report.
- [Analysis of Requirements](https://umr-astre.pages.mia.inra.fr/sit-design/requirements.html)
Difficulties related to the generalisations (line releases, different release points, multiple species, possibility of adult traps in a control area, ...), lack of references and sufficient details in the documentation.
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).
- concerns about the appropriateness of the proposed procedures under certain circumstances (competitiveness, flight range),
Led to the need of carefully revising, rethinking, proposing and validating alternatives to several procedures.
- 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.
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`](https://forgemia.inra.fr/umr-astre/sit-design/-/issues/13).
- A professional illustrator designed a logo which was validated by the commissioners amongst [other prototypes](https://forgemia.inra.fr/umr-astre/sit-design/-/issues/25).
```{r fig.width = 3}
knitr::include_graphics(here::here("reports/logo/Logo_sit_final_BR_web.png"))
```
```{r out.width = "30%"}
knitr::include_graphics(here::here("reports/logo/Logo_sit_final_BR_web.png"))
```
# 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.
# R-package and documentation
# R-package
The main product delivered as the project outcome is the R-package itself and
associated 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.
- 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.
- 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.
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](https://listes.cirad.fr/sympa/info/sit) for support and
announcements has been set up with the commitment to provide reasonable
assistance for an indefinite period.
- A [bug-tracking](http://forgemia.inra.fr/umr-astre/sit/issues) system has been
opened for reporting and tracking issues and feature-requests.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment