Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion 01_R_Insee/Fiche_installer_packages.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ D'un point de vue technique, un _package_ est constitué d'objets `R` (la plupar

Les _packages_ `R` sont disponibles sur des sites spécialisés appelés dépôts (_repositories_ ou _repo_ en anglais). Le principal dépôt est le dépôt officiel du projet `R`, le [CRAN](https://cran.r-project.org) (_Comprehensive R Archive Network_).

Les _packages_ peuvent également être mis à disposition par leurs auteurs sur les forges logicielles (telles que Github et Gitlab), mais il s'agit alors la plupart du temps de versions expérimentales dont l'usage est principalement destiné aux utilisateurs avancés de `R`.
Les _packages_ peuvent également être mis à disposition par leurs auteurs sur les forges logicielles (telles que GitHub et GitLab), mais il s'agit alors la plupart du temps de versions expérimentales dont l'usage est principalement destiné aux utilisateurs avancés de `R`.

::: {.callout-note}
Le CRAN dispose de plusieurs copies, appelées _miroirs_, dont la plupart sont hébergés sur des [serveurs d'universités ou d'établissements de recherche](https://cran.r-project.org/mirrors.html). Télécharger un _package_ sur un miroir ou un autre est strictement équivalent. L'intérêt de choisir un miroir proche de sa localisation permet simplement de gagner en vitesse et de réduire les flux sur le réseau.
Expand Down
2 changes: 1 addition & 1 deletion 01_R_Insee/Fiche_utiliser_utilitR.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Trois points importants sont à noter :

**La documentation `utilitR` est composée de fiches regroupées en deux grandes parties** :

- La première partie explique comment utiliser `R` et RStudio et les outils associés (`git`, Gitlab) dans les environnements informatiques proposés à l'Insee (AUSv3 et SSP Cloud).
- La première partie explique comment utiliser `R` et RStudio et les outils associés (`git`, GitLab) dans les environnements informatiques proposés à l'Insee (AUSv3 et SSP Cloud).
- La seconde partie est constituée de fiches thématiques expliquant comment réaliser des tâches standards avec `R` (importation et manipulation de données, exploitation d'enquêtes, réalisation de graphiques, rédaction de documents...).

## Contenu des fiches
Expand Down
34 changes: 17 additions & 17 deletions 01_R_Insee/Travail_avec_R_Insee.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

## Démarrage rapide de `R` à l'Insee

- où clique-t-on pour accéder à Rstudio? Description rapide des environnements: local, AUS, PF innovation.
- où clique-t-on pour accéder à RStudio? Description rapide des environnements: local, AUS, PF innovation.
- Comment on installe un _package_?
- Comment on crée un projet Rstudio?
- Comment on crée un projet RStudio?

## Utiliser `R` et `Rstudio` à l'Insee?
## Utiliser `R` et `RStudio` à l'Insee?

### Les différents environnements d'usage de `R` à l'Insee

Expand All @@ -16,20 +16,20 @@

#### Utiliser `R` en local

- Comment on installe `R` et Rstudio.
- Comment on lance Rstudio.
- Comment on installe `R` et RStudio.
- Comment on lance RStudio.

#### Utiliser `R` sous AUS

- Comment on se connecte à AUS;
- Comment on lance Rstudio.
- Comment on lance RStudio.

#### Utiliser `R` sur la PF innovation

- Comment on se crée un compte sur la PF innovation;
- Comment on lance un container Rstudio.
- Comment on lance un container RStudio.

### Utiliser les projets Rstudio pour structurer son travail
### Utiliser les projets RStudio pour structurer son travail

Reprendre (en version très allégée) la partie 3 de la formation Travail Collaboratif sous `R`.

Expand All @@ -42,7 +42,7 @@ Parler du fichier `.Rprofile`, et dire ce qui peut être configuré.

### Installer des _packages_

- Quelles sont les sources pour les _packages_? CRAN, Github...
- Quelles sont les sources pour les _packages_? CRAN, GitHub...
- Expliquer qu'il y a des miroirs pour AUS;
- Expliquer comment installer un _package_ (et aussi *binary* _versus_ *source*).

Expand All @@ -53,21 +53,21 @@ Cette partie peut être ici, ou transférée dans la partie Fiches thématiques.

## La gestion de version

### Utiliser Git et Rstudio
### Utiliser Git et RStudio

#### Introduction à Git

- Des bases de `Git`: Reprendre la partie 4.2 de la formation Travail Collaboratif sous R.

#### Git dans Rstudio
#### Git dans RStudio

- Où mettre son dépôt local `Git` (en local et dans AUS)
- Utiliser `Git` avec l'interface `Rstudio`
- Utiliser `Git` avec l'interface `RStudio`

### Le Gitlab interne
### Le GitLab interne

- Présentation du Gitlab interne
- Configurer son accès à Gitlab (SSH, Putty etc.)
- Comment travailler à plusieurs avec Gitlab? Reprendre la partie 4.4 de la formation Travail Collaboratif sous R.
- Présentation du GitLab interne
- Configurer son accès à GitLab (SSH, Putty etc.)
- Comment travailler à plusieurs avec GitLab? Reprendre la partie 4.4 de la formation Travail Collaboratif sous R.

## Se former à `R` à l'Insee
## Se former à `R` à l'Insee
8 changes: 4 additions & 4 deletions 01_R_Insee/presentation_utilitr.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ Les contributeurs du projet `utilitR` se sont fixés pour objectif de **rassembl
**Le projet `utilitR` est un projet collaboratif, évolutif, *open source* et ouvert à tous, porté par des agents de l'Insee et du Service Statistique Public (SSP).**
Toute personne qui le souhaite peut modifier la documentation ou la compléter en fonction de ses connaissances et de ses expériences (voir [Comment contribuer au projet `utilitR`](#contribuer)).

Le code source de cette documentation est hébergé sous `Github` et est accessible en cliquant sur [ce lien](https://github.com/InseeFrLab/utilitR).
Le code source de cette documentation est hébergé sous `GitHub` et est accessible en cliquant sur [ce lien](https://github.com/InseeFrLab/utilitR).

## Comment contribuer à `utilitR`? {#contribuer}

**Le projet `utilitR` est un projet collaboratif, évolutif, *open source* et ouvert à tous, auquel tous les agents peuvent contribuer.** Le projet est mené par un groupe de contributeurs qui en définissent eux-mêmes le contenu, la structure et le calendrier.
Le dépôt de la documentation est situé sur le compte `InseeFrLab` sur la plateforme `Github` et peut
Le dépôt de la documentation est situé sur le compte `InseeFrLab` sur la plateforme `GitHub` et peut
facilement être retrouvé à [cette adresse](https://github.com/InseeFrLab/utilitR).
Les objectifs et l'approche collaborative du projet `utilitR` sont détaillés dans le document [`Manifeste.md`](https://github.com/InseeFrLab/utilitR/blob/master/Manifeste.md).

Expand All @@ -25,7 +25,7 @@ Les objectifs et l'approche collaborative du projet `utilitR` sont détaillés d
Tout agent intéressé à contribuer au projet est invité à consulter le guide des contributeurs [`CONTRIBUTING.md`](https://github.com/InseeFrLab/utilitR/blob/master/CONTRIBUTING.md).
[Ce guide](https://github.com/InseeFrLab/utilitR/blob/master/CONTRIBUTING.md)
donne également quelques astuces pour les personnes n'étant pas familières
avec `Github`.
avec `GitHub`.

## Contributeurs du projet

Expand Down Expand Up @@ -60,5 +60,5 @@ pour l'adapter à un contexte différent. Les conditions de réutilisation sont
dans la [licence](https://github.com/InseeFrLab/utilitR/blob/master/LICENSE.md).

Bien que ce ne soit en rien obligatoire,
si vous êtes réutilisateurs de la documentation, n'hésitez pas à vous signaler sur notre [`Github`](https://github.com/InseeFrLab),
si vous êtes réutilisateurs de la documentation, n'hésitez pas à vous signaler sur notre [`GitHub`](https://github.com/InseeFrLab),
vos retours pourraient permettre d'améliorer la documentation, au bénéfice de tous.
2 changes: 1 addition & 1 deletion 02_Bonnes_pratiques/02-nommage.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Les fonctions de base `R` utilisent des points dans les noms de fonctions ( `con

<span style="color:DarkBlue">**Versions**</span>

* **L'utilisation d'outils de contrôle de version tel que `git` est recommandée et est très bien intégrée dans ` RStudio`.** L'intérêt de `git` est de permettre un suivi des évolutions du fichier bloc par bloc et contributeur par contributeur. Dans ce cas, il n'est pas nécessaire de millésimer les fichiers, l'historique des modifications d'un fichier étant géré par `git` (cf. Section [Contrôle de version](#git)). Pour le *versioning*, on pourra également utiliser le Gitlab interne de la Drees ou de l'Insee.
* **L'utilisation d'outils de contrôle de version tel que `git` est recommandée et est très bien intégrée dans ` RStudio`.** L'intérêt de `git` est de permettre un suivi des évolutions du fichier bloc par bloc et contributeur par contributeur. Dans ce cas, il n'est pas nécessaire de millésimer les fichiers, l'historique des modifications d'un fichier étant géré par `git` (cf. Section [Contrôle de version](#git)). Pour le *versioning*, on pourra également utiliser le GitLab interne de la Drees ou de l'Insee.
* **En l'absence de système de contrôle de version (`git` ou `SVN`), il est recommandé de millésimer les fichiers (scripts et données).** Pour les données, on millésimera systématiquement avec la date (pour les agents de la Drees, la fonction `rdrees::exporter_data` propose de le faire automatiquement).

<span style="color:DarkBlue">**Organisation**</span>
Expand Down
2 changes: 1 addition & 1 deletion 02_Bonnes_pratiques/02-structure-code.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ détecter lors de l'exécution de scripts `R`.
Le fichier `README.md`, situé à la racine du projet,
est à la fois la carte d'identité et la vitrine du projet. En effet, comme
il s'agit du fichier qui fait office de point d'entrée
d'un projet sur `Github` ou `Gitlab`, il s'agit de la première source
d'un projet sur `GitHub` ou `GitLab`, il s'agit de la première source
d'information pour comprendre l'objet du projet.

Idéalement, ce fichier contient :
Expand Down
10 changes: 5 additions & 5 deletions 03_Fiches_thematiques/Fiche_configurer_git.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ de commande (`Git Bash`) et une interface (`Git GUI`).

## Interaction avec un dépôt distant : principe

```{r entree_fiche_configurer_git, echo = FALSE, fig.cap = "Schéma illustratif d'un processus utilisant R, Git et Gitlab"}
```{r entree_fiche_configurer_git, echo = FALSE, fig.cap = "Schéma illustratif d'un processus utilisant R, Git et GitLab"}
knitr::include_graphics("../pics/git/gitlab.png")
```

Expand Down Expand Up @@ -114,7 +114,7 @@ La méthode SSH peut être laborieuse à mettre en place, mais elle est commode
## Spécificité Insee

Pour pouvoir utiliser l'authentification `HTTPS` avec
le `Gitlab` interne de l'Insee, il est nécessaire de modifier un paramètre
le `GitLab` interne de l'Insee, il est nécessaire de modifier un paramètre
relatif aux certificats `SSL`. Pour cela, ouvrir la ligne de commande `Git`
(démarche expliquée dans la fiche [Utiliser Git avec RStudio](#terminal-git))
et taper la commande suivante :
Expand Down Expand Up @@ -145,14 +145,14 @@ utilitr::include_image("../pics/config_git/clone_https.png", compression = FALSE
```

Au moment du clonage, l'utilisateur est invité à entrer son identifiant
(celui de son profil Gitlab avec lequel il accède au dépôt distant), ainsi que
(celui de son profil GitLab avec lequel il accède au dépôt distant), ainsi que
son mot de passe (celui qu'il aura donc spécifié dans son compte GitLab) auquel on substituera un _token_.

::: {.callout-tip}
Selon le niveau de visibilité fixé par le propriétaire du dépôt distant, il est possible qu'il ne soit pas nécessaire de s'identifier au moment du clonage (c'est le cas pour les dépôts publics). En revanche, si le niveau de visibilité du dépôt est plus élevé (niveau privé), il se peut qu'il soit impossible à l'utilisateur de cloner le dépôt ; dans ce cas, il ne lui sera pas non plus possible de visualiser ce dernier dans GitLab. Il faut alors contacter le propriétaire du dépôt pour lui en demander l'accès.
:::

### Définir un jeton d'accès sur Gitlab
### Définir un jeton d'accès sur GitLab

Dans `GitLab`, en haut à droite de la page, cliquer sur `Edit profile` :

Expand Down Expand Up @@ -269,7 +269,7 @@ utilitr::include_image("../pics/config_git/ssh_keygen.png", compression = FALSE)

La clé est générée sur le chemin spécifié et sera constituée de deux fichiers texte :

- un fichier dont le nom se termine par `.pub` (comme _Public Key_) qui fournit la partie publique de la clé, et qui a vocation à être diffusée (donc c'est ce fichier qu'on chargera sur Gitlab pour permettre l'authentification) ;
- un fichier dont le nom se termine par `.pub` (comme _Public Key_) qui fournit la partie publique de la clé, et qui a vocation à être diffusée (donc c'est ce fichier qu'on chargera sur GitLab pour permettre l'authentification) ;
- un fichier dont le nom se termine par `.ppk` (comme _Private Key_) qui est la partie privée de la clé, et qui ne doit **être diffusée en aucun cas**.

La version privée de la clé doit être localisée dans un dossier caché que Git va automatiquement utiliser (en général un dossier `.ssh` localisé sur un dossier personnel).
Expand Down
6 changes: 3 additions & 3 deletions 03_Fiches_thematiques/Fiche_datatable.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -211,17 +211,17 @@ dt[y > 3, newvar := 1]
</tr>
<tr>
<th>
```{asis, eval=TRUE, echo=TRUE}
```{asis, eval = TRUE, echo=TRUE}
**Signification**
```
</th>
<th>
```{asis, eval=TRUE, echo=TRUE}
```{asis, eval = TRUE, echo=TRUE}
Partir de `dt`, conserver uniquement les observations pour lesquelles `x > 3`, et créer une nouvelle variable `newvar` qui vaut 1 partout
```
</th>
<th>
```{asis, eval=TRUE, echo=TRUE}
```{asis, eval = TRUE, echo=TRUE}
Partir de `dt`, créer une nouvelle variable `newvar` qui vaut 1 pour les observations pour lesquelles `x > 3` et `NA` ailleurs</th>
```
<tr>
Expand Down
2 changes: 1 addition & 1 deletion 03_Fiches_thematiques/Fiche_donnees_spatiales.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ Contrairement à ce qui pourrait être pensé, la géographie et le COG sont ré
Le *package* [COGugaison](https://antuki.github.io/COGugaison/) fournit un ensemble d'outils répondant à ce besoin. Il permet de réaliser de nombreuses modifications utiles au chargé d'études (remplacement des codes arrondissements dans Paris, Lyon, Marseille, identification du millésime géographique des données, visualisation des changements de géographie, transformation d'un millésime à un autre pour les communes, les zonages standards d'études de l'Insee, et les zonages à façon, etc.) sans avoir à mobiliser le COG.

::: {.callout-note}
Ce package n'étant pas disponible sur le CRAN, dans un environnement connecté à internet, il est nécessaire de l'installer depuis `Github`:
Ce package n'étant pas disponible sur le CRAN, dans un environnement connecté à internet, il est nécessaire de l'installer depuis `GitHub`:

```{r, eval=FALSE}
remotes::install_github("antuki/COGugaison")
Expand Down
Loading