10-Optimisation.Rmd

# Optimisation & test {#optimisation}

[cette section doit encore être écrite en grande partie]

#### Objectifs {.unnumbered}

-   Appréhender les notions liées aux packages

-   Apprendre à créer un package

-   ...

#### Prérequis {.unnumbered}

Vous devez être familiarisés avec l'écriture et la documentation de fonction (module 9 de ce cours).

Vous devez également être familiarisés avec les tests unitaires.

## Package R {#package}

À chaque utilisation R, vous employez des fonctions sans plus y porter attention comme la fonction `labelise()` par exemple. Cette fonction provient du package {data.io}. Un package est un ensemble de fonctions documentées, de jeu de données, de vignettes (des tutoriels)... Vous pouvez très facilement retrouver des informations sur les packages que vous utilisez en cliquant sur l'onglet `Packages` dans RStudio. Vous y trouverez la liste des packages que vous avez installés sur votre ordinateur, une courte description et le numéro de la version de ce package. Nous reviendrons plus en détail sur le numéro de version lors de la création de votre premier package.

L'utilisation de packages R a de nombreux avantages :

-   On évite de répéter des fonctions dans des script R de projet en projet.

-   On limite les possibilités de bug entre les script R.

-   Les fonctions d'un package sont documentées.

-   On rend notre code plus lisible.

## Création d'un package {#creerunpackage}

Afin de nous aider dans la création d'un package, le package {[usethis}](https://usethis.r-lib.org) a été mis au point pour simplifier et proposer un workflow cohérent de création de package R.

### Nom d'un package

Avant de vous lancer dans la création d'un package, il faut lui trouver un nom. Le choix du nom d'un package est compliqué. Il est cependant possible d'employer la fonction `available()` du package {available} pour vous aider

```{r, eval=FALSE}
available::available(name= "nom_potentiel_du_package")
```

```{=html}
<!---- G.E.
- description d'un package
- devtools_history.R pour la reproductibilité
- license
- vignette
- documentation
- gestion de versions
- readme
- intégration continue
- ...
--->
```

##### À vous de jouer ! {.unnumbered}

```{r assign_D08Ga_project_III, echo=FALSE, results='asis'}
if (exists("assignment"))
  assignment("D08Ga_project", part = "III",
    url = "https://github.com/BioDataScience-Course/D08Ga_project",
    course.ids = c(
      'S-BIOG-043'         = !"D08Ia_{YY}M_project"),
    course.urls = c(
      'S-BIOG-043'         = !"{assign_url$D08Ga_project}"),
    course.starts = c(
      'S-BIOG-043'         = !"{class1_start(mod, 'D08')}"),
    course.ends = c(
      'S-BIOG-043'         = !"{n4_end(mod, 'D10')}"),
    term = "Q1", level = 4, n = 1,
    toc = "Organisation d'un projet (partie III)")
```

##### Pour en savoir plus {.unnumbered}

-   [Créer un package R en quelques minutes](https://thinkr.fr/creer-package-r-quelques-minutes/), courte explication sur la création d'un package R, en français.

-   [{usethis}](https://usethis.r-lib.org), documentation d'un package qui aide à réaliser des packages, en anglais.

## Récapitulatif des exercices {#recapitulatifd10}

Dans ce module 10, vous aviez à réaliser les exercices suivants :

`r show_ex_toc("10", finalize = TRUE)`

##### Progression {.unnumbered}

`r launch_report("10", height = 800)`