Skip to content

Commit

Permalink
Relooking homepage (#500)
Browse files Browse the repository at this point in the history
* premiers tests homepage

* cards 2

* ajoute cartes

* new cards

* rm pdf test

* improve navigation

* prepare des cards

* Retour du système de briques avec ojs

* update

* test box

* box recommandation

* recommandation box

* update
  • Loading branch information
linogaliana authored Dec 4, 2023
1 parent bfec792 commit 996a399
Show file tree
Hide file tree
Showing 56 changed files with 5,778 additions and 5,140 deletions.
33 changes: 0 additions & 33 deletions .github/workflows/pagedown-test.yaml

This file was deleted.

11 changes: 7 additions & 4 deletions 01_R_Insee/Fiche-personnaliser-R.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

L'agent souhaite personnaliser sa configuration de `R`. Cette personnalisation consiste à définir certaines actions ou valeurs qui seront effectuées automatiquement à l'ouverture d'une session `R`.

::: {.callout-recommandation .icon}
::: {.callout-important}
## Tâche concernée et recommandation

**La personnalisation de `R` doit être maniée avec précaution**, car personnaliser votre environnement de travail, c'est prendre le risque de rendre vos travaux difficiles à reproduire. Cette fiche vous explique ce que la personnalisation peut apporter, et ce pour quoi elle ne doit pas être utilisée.

Expand Down Expand Up @@ -78,7 +79,7 @@ Un tel fichier n'est pas constitué de code `R`, mais de paires **nom=valeur**.
* il modifie des variables internes à `R` (telles que `_R_CHECK_LENGTH_1_CONDITION_` et `_R_CHECK_LENGTH_1_LOGIC2_`) ;
* il **contient une ligne vide finale** : cette ligne vide est indispensable, ne l'oubliez jamais !

::: {.callout-conseil .icon}
::: {.callout-tip}
Voici **deux conseils importants** sur l'usage du fichier d'environnement `.Renviron` :

- il est recommandé d'être très prudent dans la personnalisation du fichier d'environnement ;
Expand All @@ -92,7 +93,9 @@ La méthode la plus simple pour modifier le fichier `.Renviron` est la suivante
3. Sauvegarder le fichier.
3. Relancer `R`, via `Session > Restart R` ou <kbd>Ctrl</kbd> + <kbd>⇧ Shift</kbd> + <kbd>F10</kbd> dans `RStudio`.

::: {.callout-insee .icon}
::: {.callout-warning}
## Spécificité Insee

Comme dans de nombreuses institutions, la navigation sur Internet depuis un poste de l'Insee est contrôlée par un *proxy* (intermédiaire entre le *web* et un ordinateur). Il est indispensable de paramétrer l'adresse du _proxy_ pour que `R` puisse accéder à Internet (par exemple pour télécharger un _package_). Pour ce faire, vous pouvez récupérer l'adresse du _proxy_ de l'Insee en exécutant la commande suivante :
```{r ie_get_proxy_for_url, eval=FALSE}
curl::ie_get_proxy_for_url()
Expand Down Expand Up @@ -150,7 +153,7 @@ La fonction `options()` affiche les valeurs actuellement chargées pour les opti

Un exemple plus réaliste de `.Rprofile` peut être trouvé [ici](https://github.com/InseeFrLab/utilitR/blob/master/.Rprofile) : c'est le fichier qui permet notamment de réaliser la documentation `utilitR`. Notez notamment le message à l'ouverture du projet. Avoir des fonctions n'est pas forcément interdit, tant que ces fonctions sont également partagées, comme c'est le cas dans ce projet !

::: {.callout-conseil .icon}
::: {.callout-tip}
Il n'est nullement obligatoire de définir des réglages spécifiques avec un fichier `.Rprofile`. Toutefois, si vous le faites, il est fortement conseillé de :

* travailler dans le `.Rprofile` d'un projet, et non pas le `.Rprofile` général de votre profil d'utilisateur ;
Expand Down
13 changes: 8 additions & 5 deletions 01_R_Insee/Fiche_installer_packages.qmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Utiliser des _packages_ `R` {#utiliser-packages}

::: {.callout-recommandation .icon}
::: {.callout-important}
## Tâche concernée et recommandation

- Avant d'installer un _package_, il est indispensable de déterminer précisément quel est le _package_ dont vous avez besoin. Pour cela, vous pouvez consulter les autres fiches de la documentation `utilitR`, et la fiche [Comment choisir un _package_ ?].
- Il est recommandé d'utiliser la fonction `install.packages` pour installer et mettre à jour les _packages_, sans modifier les arguments `repos`, `lib`, `type` et `dependencies`. L'usage de la fonction `update.packages` est destiné à des usages avancés.
- Il est recommandé d'utiliser la fonction `library` pour charger les _packages_ sans modifier l'argument `lib.loc`.
Expand All @@ -27,7 +29,7 @@ Les _packages_ `R` sont disponibles sur des sites spécialisés appelés dépôt

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-remarque .icon}
::: {.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 Expand Up @@ -122,7 +124,7 @@ permet ainsi de récupérer la version de développement d'un _package_
un _package_ tel qu'il était à un moment donné, il est également possible de
faire suivre le nom du dépôt par une référence à un `r with_def("commit")`, à un _tag_ (une version) ou à une `r with_def("branche")`. Voici un exemple avec un _tag_ : `remotes::install_gitlab("py_b/[email protected]")`. Voici un exemple avec un commit : `remotes::install_github("InseeFrLab/doremifasolData@a9df2d3d0e372")`.

::: {.callout-remarque .icon}
::: {.callout-note}
Lorsque vous installez un _package_ depuis une forge logicielle, `R` crée automatiquement une archive temporaire (un fichier `.tar.gz`), puis installe le _package_ à partir de celle-ci. Si vous travaillez dans un environnement Windows, il est nécessaire que `Rtools` soit installé sur votre poste pour que `R` puisse construire l'archive.

`Rtools` est un logiciel (pas un _package_) qui contient un certain nombre d'outils pour construire des _packages_ `R` sous Windows. `Rtools` n'est en revanche pas nécessaire sur les systèmes Mac ou Linux. Vous pouvez vérifier si `Rtools` est installé en exécutant la fonction `pkgbuild::has_rtools()`. Celle-ci renvoie `TRUE` si `Rtools` est installé, `FALSE` sinon. Si `Rtools` n'est pas installé, vous pouvez l'installer facilement en le téléchargeant sur internet.
Expand Down Expand Up @@ -166,7 +168,8 @@ Chacune de ces manipulations effectuées par l'intermédiaire de l'interface gra
Lors de l'ouverture d'un script, `RStudio` tente aussi de détecter automatiquement si les _packages_ utilisés dans celui-ci sont installés. Dans le cas contraire, il affiche un bandeau en haut du script proposant d'installer les _packages_ manquants :
`▲ _package_ --- required but is not installed. Install Don't show again`

::: {.callout-insee .icon}
::: {.callout-warning}
## Spécificité Insee
Il ne faut pas essayer d'installer des _packages_ en cliquant sur le bouton <kbd> Install </kbd> du bandeau si vous travaillez dans AUS. En effet, si vous cliquez sur ce bouton, RStudio essaie de télécharger le _package_ depuis le CRAN (qui n'est pas accessible depuis AUS). Il faut utiliser la fonction `install.packages` à la place.
:::

Expand All @@ -180,7 +183,7 @@ library(ggplot2)

Par défaut, la fonction `library` cherche le _package_ dans la librairie d'installation des _packages_ (voir le paragraphe \@ref(libraries)). `R` renvoie une erreur s'il ne trouve pas le _package_ considéré dans la librairie. Il est possible de modifier la librairie dans laquelle la fonction `library` cherche les _packages_ grâce à l'argument `lib.loc`, mais vous n'avez normalement pas besoin de le faire dans le cadre d'un usage standard de `R`.

::: {.callout-conseil .icon}
::: {.callout-tip}
Il est indispensable de rassembler les instructions de chargement de _package_ au début des programmes `R`, car cela permet à un utilisateur qui ne connaît pas les programmes de repérer facilement les _packages_ utilisés.
:::

Expand Down
14 changes: 8 additions & 6 deletions 01_R_Insee/Fiche_utiliser_Rstudio_AUSv3.qmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Utiliser RStudio sur l'environnement AUSv3 {#AUSv3}

::: {.callout-recommandation .icon}
::: {.callout-important}
## Tâche concernée et recommandation

La collection RPython d'AUSv3 est l'environnement de référence pour réaliser des tâches de production statistique et des études avec `R` et RStudio. C'est notamment sur cette collection qu'il est possible de traiter des données confidentielles avec `R` et RStudio.

Expand All @@ -18,15 +19,16 @@ Les serveurs AUSv3 sont des environnements informatiques de travail sur lesquels

Une collection AUSv3 est un regroupement de serveurs tous strictement identiques entre eux : les ressources informatiques, la configuration et les logiciels disponibles sont exactement les mêmes sur les différents serveurs d'une collection. En revanche, les collections sont différentes entre elles. Par exemple, tous les serveurs de la collection RPython disposent `R`, `RStudio` et `Python` (mais pas de SAS), et tous les serveurs de la collection SAS disposent de SAS (mais pas de RStudio ni de Python).

::: {.callout-insee .icon}
::: {.callout-warning}
## Spécificité Insee

Les serveurs AUSv3 font l'objet d'une documentation fournie. Cette documentation se trouve principalement sur l'intranet Insee. Vous pouvez y accéder par l'intranet, puis en cliquant sur `Services > DSI > Libre Service statistique > AUS V3`.

Des fiches et des tutoriels sont également disponibles dans AUSv3, dans le lecteur `Commun`.
:::


::: {.callout-conseil .icon}
::: {.callout-tip}
Le document de référence sur l'utilisation d'AUSv3 est le guide de l'utilisateur d'AUSv3 disponible
depuis l'intranet.
:::
Expand All @@ -47,7 +49,7 @@ Vous devriez recevoir des emails vous indiquant que votre accès à AUS a été
![](../pics/AUSv3/AUSv3.png)


::: {.callout-conseil .icon}
::: {.callout-tip}
Si votre accès à AUS n'est pas créé rapidement, vous pouvez ouvrir un ticket `Siamoi`.
:::

Expand Down Expand Up @@ -82,11 +84,11 @@ D'une manière générale, `R` et `RStudio` s'utilisent sur AUSv3 de la même ma

Pour plus de détails concernant ces points, consulter les fiches [Utiliser des _packages_ `R`](#utiliser-packages) et [Personnaliser la configuration de `R`](#personnaliser).

::: {.callout-remarque .icon}
::: {.callout-note}
Il est possible de demander la mise à disposition dans AUSv3 de _packages_ non disponibles sur le CRAN. Pour ce faire, il faut déposer une demande métier sur `Siamoi`.
:::

::: {.callout-conseil .icon}
::: {.callout-tip}
Les ressources informatiques des serveurs AUSv3 (mémoire vive et processeurs) sont
partagées entre les applications et les utilisateurs. Il est donc essentiel de
veiller à faire un bon usage de ces ressources, de façon à ne pas gêner
Expand Down
14 changes: 8 additions & 6 deletions 01_R_Insee/Fiche_utiliser_Rstudio_SSPCloud.qmd
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# Utiliser `RStudio` sur l'environnement SSP Cloud {#sspcloud}

::: {.callout-recommandation .icon}
::: {.callout-important}
## Tâche concernée et recommandation

Vous pouvez utiliser `R` et RStudio sur le SSP Cloud pour mener des expérimentations qui seraient difficiles à réaliser dans AUS. En revanche, le SSP Cloud ne doit pas être utilisé pour réaliser des tâches de production statistique, ni pour traiter des données confidentielles.
:::

::: {.callout-remarque .icon}
::: {.callout-note}
Certains exemples de cette fiche utilisent les données disponibles dans le _package_ `doremifasolData` ; vous ne pourrez reproduire ces exemples que si ce _package_ est installé sur la machine sur laquelle vous travaillez. Si vous ne savez pas si ce _package_ est déjà installé, consultez la fiche [Comment utiliser la documentation `utilitR`](#presentation-utilitr).
:::

Expand All @@ -26,7 +28,7 @@ Il est nécessaire de disposer d'un compte personnel **SSP Cloud** pour en utili
- vous devez utiliser votre adresse mail professionnelle (de l'Insee ou de votre SSM) ;
- **votre nom d'utilisateur ne doit contenir ni caractères accentués, ni caractère spécial, ni signe de ponctuation**. Ce point est essentiel, car votre compte ne fonctionnera pas si votre nom d'utilisateur comprend l'un de ces caractères. Pour les agents de l'Insee, le plus simple est de choisir votre IDEP puisqu'il respecte ces règles. Pour les agents des SSM ne disposant pas d'IDEP, vous pouvez adopter le format `prenomnom` en faisant attention aux règles précédentes. Par exemple, si vous vous appelez Jérôme-Gérard L'Hâltère, votre nom d'utilisateur pourra être `jeromegerardlhaltere`.

::: {.callout-remarque .icon}
::: {.callout-note}
La grande majorité des problèmes rencontrés à la création d'un compte SSP Cloud découle d'un `username` ne respectant pas ces règles. Dans ce cas, la seule solution consiste à demander aux administrateurs du SSP Cloud de supprimer votre compte, pour que vous puissiez en créer un nouveau. Vous pouvez contacter les administrateurs en écrivant un message sur le [salon Tchap `SSPCloud`](https://www.tchap.gouv.fr/#/room/#SSPCloudXDpAw6v:agent.finances.tchap.gouv.fr).
:::

Expand Down Expand Up @@ -149,7 +151,7 @@ Les principales options sont les suivantes :
- L'**option `version`** (dans l'onglet `Service`) détermine l'environnement dans lequel RStudio va s'ouvrir. Il s'agit d'un environnement contenant une version donnée de `R` ainsi que des packages pré-installés. Par exemple, l'image `utilitR` disponible propose l'ensemble des dépendances (elles sont nombreuses...) nécessaires pour reproduire tous les exemples présents dans cette documentation.
- L'**option `PersonalInit`** (dans l'onglet `Init`) permet de référencer un script d'initialisation qui exécutera une série d'actions prédéfinies avant de lancer le service, par exemple copier localement des données, lancer un projet RStudio ou définir des paramètres d'affichage de l'interface. Un exemple d'un tel fichier Init utilisé pour des formations peut être trouvé [ici](https://github.com/InseeFrLab/formation-r-lissage-spatial/blob/f3258469513cabd2de328dc92165641f8f452bca/utils/init.sh). C'est l'URL du fichier sur github.com qui doit être référencé, **dans sa version *Raw*** (afficher le fichier dans Github et cliquer sur `Raw` en haut à droite pour obtenir cette URL).

::: {.callout-remarque .icon}
::: {.callout-note}
**Les options d'un service RStudio ne peuvent être définies qu'au moment de la création du service.** Si vous vous rendez compte qu'une option du service ne convient pas au traitement que vous voulez faire, vous devez supprimer votre service RStudio et en lancer un nouveau avec les bonnes options. Lorsqu'un ensemble d'options vous conviennent, il est possible de l'enregistrer pour les retrouver lors du prochain lancement d'un service. Pour cela, cliquez sur l'icône de marque-page en haut à droite du panneau de paramétrage. La liste des configurations ainsi définies comme favorites apparaîtront dans SSP Cloud dans la rubrique `Mes services`, dans la colonne `Enregistrés`.
:::

Expand Down Expand Up @@ -203,7 +205,7 @@ Le SSP Cloud propose des environnements (comme les services ` RStudio`, `Jupyter
* *stockage des codes* : il est nécessaire d'utiliser une plate-forme de développement pour stocker des programmes informatiques, telles que [Gitlab](www.gitlab.com) ou [Github](www.github.com).
* *stockage des données* : la plateforme SSP Cloud propose un système de stockage de données nommé S3. Depuis votre service RStudio, vous pourrez facilement accéder à des données stockées sur S3 grâce au _package_ `aws.s3`.

::: {.callout-remarque .icon}
::: {.callout-note}
Voici deux règles à respecter pour faire un bon usage de ces deux espaces de stockage :

* Les plate-formes telles que Gitlab ou Github ne doivent **jamais** être utilisées pour stocker des données (uniquement des codes).
Expand Down Expand Up @@ -248,7 +250,7 @@ Imaginons qu'on souhaite accéder au _bucket_ nommé `donnees-insee` qui contien
aws.s3::get_bucket("donnees-insee", region = "")
```

::: {.callout-conseil .icon}
::: {.callout-tip}
La commande `get_bucket()` peut renvoyer un grand nombre de résultats si le _bucket_ contient un grand nombre de fichiers. Le _bucket_ `donnees-insee` contient ainsi plus de 1000 fichiers. Il est donc conseillé d'utiliser l'option `prefix` pour restreindre le chemin des fichiers que l'on souhaite lister. Par exemple, le code suivant fournit la liste des fichiers situés dans le répertoire `diffusion/ESTEL/2015` du _bucket_ `donnees.insee` :

```{r, eval = FALSE}
Expand Down
Loading

0 comments on commit 996a399

Please sign in to comment.