Skip to content

Commit

Permalink
remove www in book.utilitr.org (#520)
Browse files Browse the repository at this point in the history
  • Loading branch information
antoine-palazz committed Apr 10, 2024
1 parent d41712d commit 4ed3f0b
Show file tree
Hide file tree
Showing 9 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion 02_Bonnes_pratiques/06-outils.qmd
Expand Up @@ -76,7 +76,7 @@ style_file(path = "inst/app/ui.R")
#> Please review the changes carefully!
```

Le fichier a été modifié et grâce à [`Git`](https://www.book.utilitr.org/git.html) on peut facilement parcourir tous les changements de style effectués par le package. Par exemple :
Le fichier a été modifié et grâce à [`Git`](https://book.utilitr.org/git.html) on peut facilement parcourir tous les changements de style effectués par le package. Par exemple :

![Conséquence de `styler`](./pics/bonnespratiques/img_styler.png){width=100%}
Enfin le package `styler`permet de définir votre propre guide de style et de formater du code en fonction de celui-ci. Pour en savoir plus, consultez [cette vignette](https://styler.r-lib.org/articles/customizing_styler.html)
Expand Down
4 changes: 2 additions & 2 deletions 03_Fiches_thematiques/Fiche_donnees_spatiales.qmd
Expand Up @@ -54,7 +54,7 @@ Les fonctions de `sf` sont pour la plupart préfixées par `st_` *(Spatial Type)
**Le *package* `sf` introduit un objet géographique particulier : la table de données spatiale appelée `sf`. Un `sf` est simplement une table de données `R` traditionnelle (un `data.frame`), enrichie d'une colonne supplémentaire `geometry` qui contient l'information géographique.** Par conséquent, toutes les fonctions qui s'appliquent à un `data.frame` s'appliquent exactement de la même façon aux attributs des objets `sf`.

::: {.callout-note}
Le *package* `sf` est une extension du *package* `dplyr` pour les objets géographiques. On peut donc utiliser le *pipe* (`%>%`) pour chaîner des opérations avec `sf`, ce qui est souvent pratique (voir la fiche [Manipuler des données avec le tidyverse](https://www.book.utilitr.org/03_fiches_thematiques/fiche_tidyverse#enchaîner-les-manipulations-avec-lopérateur-pipe)).
Le *package* `sf` est une extension du *package* `dplyr` pour les objets géographiques. On peut donc utiliser le *pipe* (`%>%`) pour chaîner des opérations avec `sf`, ce qui est souvent pratique (voir la fiche [Manipuler des données avec le tidyverse](https://book.utilitr.org/03_fiches_thematiques/fiche_tidyverse#enchaîner-les-manipulations-avec-lopérateur-pipe)).
:::

### Créer une table de données spatiales
Expand Down Expand Up @@ -248,7 +248,7 @@ Les limites administratives de référence sont disponibles sur le site

Le code officiel géographique (COG), qui tient à jour les entités administratives (codes communes, régions, etc.)
est disponible sur [le site de l'Insee](https://www.insee.fr/fr/information/2560452) et via
l'API Métadonnées. La [fiche API](https://www.book.utilitr.org/03_fiches_thematiques/fiche_api) indique comment accéder à des données via une API.
l'API Métadonnées. La [fiche API](https://book.utilitr.org/03_fiches_thematiques/fiche_api) indique comment accéder à des données via une API.

::: {.callout-tip}
Contrairement à ce qui pourrait être pensé, la géographie et le COG sont régulièrement modifiés, pour prendre notamment en compte des fusions et scissions de communes. Deux ensembles apparemment identiques de codes communes au 1er janvier 2022 et 1er janvier 2021 peuvent ainsi différer, et il convient de retraiter ses données pour s'assurer qu'elles sont toutes définies dans une même géographie.
Expand Down
2 changes: 1 addition & 1 deletion 03_Fiches_thematiques/Fiche_donnees_temporelles.qmd
Expand Up @@ -522,7 +522,7 @@ ggplot(sunspots_df, aes(x=date, y=value)) +

Pour plus d'informations sur l'utilisation de `ggplot2`, voir la [fiche
sur les
graphiques](https://www.book.utilitr.org/03_fiches_thematiques/fiche_graphiques)
graphiques](https://book.utilitr.org/03_fiches_thematiques/fiche_graphiques)

### Package `dygraphs`

Expand Down
2 changes: 1 addition & 1 deletion 03_Fiches_thematiques/Fiche_graphiques.qmd
Expand Up @@ -21,7 +21,7 @@ Certains exemples de cette fiche utilisent les données disponibles dans le _pac

Le _package_ `esquisse` propose une interface graphique qui facilite la construction de graphiques avec `ggplot2`. L'objectif de ce *package* est de vous aider à construire rapidement un code `ggplot2` pour faire le graphique que vous voulez. En revanche, **l'utilisation d'`esquisse` ne remplace pas l'écriture d'un code `ggplot2`, et cet _add-in_ ne doit pas être utilisé pour réaliser et exporter un graphique sans sauvegarder le code qui le produit** (sinon vous ne pourrez ni reproduire ni modifier votre graphique par la suite).

Vous pouvez en apprendre davantage sur les *add-ins* dans le paragraphe de [présentation des _add-ins_](https://www.book.utilitr.org/03_fiches_thematiques/fiche_rprojects#les-addins-rstudio).
Vous pouvez en apprendre davantage sur les *add-ins* dans le paragraphe de [présentation des _add-ins_](https://book.utilitr.org/03_fiches_thematiques/fiche_rprojects#les-addins-rstudio).

::: {.callout-tip}
L'interface graphique d'`esquisse` est assez gourmande en ressources, il est donc déconseillé de l'utiliser avec des données volumineuses (plus de 100 000 observations). Si vous êtes dans cette situation, **il est fortement conseillé d'utiliser `esquisse` sur une petite partie de vos données** (les 1 000 ou 10 000 premières lignes par exemple). Une fois que vous avez construit le code `ggplot2`, vous pouvez le copier-coller dans un script `R` et réaliser le graphique sur l'ensemble des données.
Expand Down
4 changes: 2 additions & 2 deletions 03_Fiches_thematiques/Fiche_import_fichiers_parquet.qmd
Expand Up @@ -73,7 +73,7 @@ Pour cette utilisation, le statisticien privilégiera un système de gestion de

Les tables Parquet sont encore loin d'être majoritaires dans les liens de téléchargement notamment face au format csv. C'est la raison pour laquelle, nous allons dans cette section dérouler **le processus pour obtenir un fichier Parquet à partir d'un fichier csv.**

Dans un premier temps, on importe le fichier plat avec la fonction **fread()** du _package_ **data.table**, conformément aux recommandations de [la fiche sur les imports de fichiers plats](https://www.book.utilitr.org/03_fiches_thematiques/fiche_import_fichiers_plats). On obtient un objet `data.table` en mémoire. Dans un second temps, on exporte ces données en format Parquet avec la fonction `write_parquet()` du _package_ `arrow`.
Dans un premier temps, on importe le fichier plat avec la fonction **fread()** du _package_ **data.table**, conformément aux recommandations de [la fiche sur les imports de fichiers plats](https://book.utilitr.org/03_fiches_thematiques/fiche_import_fichiers_plats). On obtient un objet `data.table` en mémoire. Dans un second temps, on exporte ces données en format Parquet avec la fonction `write_parquet()` du _package_ `arrow`.

```{r, eval=FALSE}
library(data.table)
Expand Down Expand Up @@ -246,7 +246,7 @@ Les _packages_ `arrow` et `duckdb` présentent une grande différence avec les _

<!-- ## Exploiter un fichier Parquet avec le _package_ `duckdb` -->

<!-- Dans le cas de fichiers volumineux, il est également possible de les requêter avec le langage `SQL` grâce au _package_ [`duckdb`](https://duckdb.org/docs/api/r.html). Cette méthode est basée sur le moteur portable `DuckDB` qui permet à n'importe quel ordinateur d'accéder à des performances d'un moteur de base de données classique qui utilise un serveur. Pour plus d'informations sur la façon d'exécuter des requêtes sur des bases de données, consultez [cette fiche](https://www.book.utilitr.org/03_fiches_thematiques/fiche_connexion_bdd#ex%C3%A9cuter-des-requ%C3%AAtes). En fonction des cas d'usage, la méthode présentée ici peut être encore plus efficace que celle avec `arrow` et `dplyr`, mais elle implique de savoir exprimer les requêtes en langage SQL. -->
<!-- Dans le cas de fichiers volumineux, il est également possible de les requêter avec le langage `SQL` grâce au _package_ [`duckdb`](https://duckdb.org/docs/api/r.html). Cette méthode est basée sur le moteur portable `DuckDB` qui permet à n'importe quel ordinateur d'accéder à des performances d'un moteur de base de données classique qui utilise un serveur. Pour plus d'informations sur la façon d'exécuter des requêtes sur des bases de données, consultez [cette fiche](https://book.utilitr.org/03_fiches_thematiques/fiche_connexion_bdd#ex%C3%A9cuter-des-requ%C3%AAtes). En fonction des cas d'usage, la méthode présentée ici peut être encore plus efficace que celle avec `arrow` et `dplyr`, mais elle implique de savoir exprimer les requêtes en langage SQL. -->

<!-- L'approche avec `duckdb` comprend trois étapes similaires à celle de l'approche avec `arrow` et `dplyr`: -->

Expand Down
2 changes: 1 addition & 1 deletion 03_Fiches_thematiques/Fiche_rmarkdown.qmd
Expand Up @@ -40,7 +40,7 @@ Il y a une grande liberté dans les formats de sortie disponibles pour un fichie

* Des rapports ou articles en `pdf`, `html`, `doc`, `odt`, etc. ;
* Des présentations sous forme de slides `pdf` ou `html` ;
* Des sites *web* (comme celui associé à [cet ouvrage](https://www.book.utilitr.org) ou comme [la page d'accueil d'utilitR](https://www.utilitr.org)).
* Des sites *web* (comme celui associé à [cet ouvrage](https://book.utilitr.org) ou comme [la page d'accueil d'utilitR](https://www.utilitr.org)).


::: {.callout-note}
Expand Down
2 changes: 1 addition & 1 deletion 03_Fiches_thematiques/Fiche_targets.qmd
Expand Up @@ -372,7 +372,7 @@ mémoire de la session `R` dans laquelle
tourne le _pipeline_. Ceci est
particulièrement utile lorsque les
objets manipulés sont volumineux (voir
la fiche [Superviser sa session R](https://www.book.utilitr.org/01_r_insee/fiche_utiliser_ressources)).
la fiche [Superviser sa session R](https://book.utilitr.org/01_r_insee/fiche_utiliser_ressources)).

Dans `targets`, cette opération est possible en ajoutant
l'argument `garbage_collection = TRUE` à la définition de
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Expand Up @@ -47,7 +47,7 @@ Pré-requis: avoir un compte Github.

Pour ce type de modifications, il est demandé d'utiliser directement
l'outil de suggestions de changements de `Github`.
Le livre déployé sur https://www.book.utilitr.org comprend un bouton `Edit` qui
Le livre déployé sur https://book.utilitr.org comprend un bouton `Edit` qui
permet de proposer, automatiquement, des modifications via l'interface de
`Github`.

Expand Down Expand Up @@ -168,7 +168,7 @@ Le lieu idéal de retour de la part d'un relecteur ou d'une relectrice dépend d
### Comment faire des commentaires sur une fiche via Github?

La démarche est un peu fastidieuse mais est possible directement depuis `Github`.
Dans le menu du site web www.book.utilitr.org,
Dans le menu du site web book.utilitr.org,
il faut d'abord se placer dans la fiche à
relire et ensuite cliquer sur le bouton `View source`, dans le menu à droite.

Expand Down Expand Up @@ -255,7 +255,7 @@ Enfin, comme montré dans la capture d'écran ci-dessous, il est possible de con

La méthode présentée ci-dessus a l'inconvénient qu'elle oblige l'utilisateur à insérer son mot de passe de façon régulière, et quoi qu'il en soit, pour chaque nouveau service RStudio créé sur le SSP Cloud. Il est ainsi possible d'insérer le mot de passe en question dans les variables d'environnement insérées au moment de la création du service, via l'interface `Mes secrets` du SSP Cloud. L'utilisateur intéressé pourra s'il le souhaite consulter la [vidéo de démonstration](https://github.com/InseeFrLab/onyxia-ui/releases/download/assets/Demo_My_Secrets.mp4) explicitant l'usage de ce service.

**ATTENTION : cette méthode comporte des risques car dans l'éventualité où un attaquant parvient à accéder à votre compte sur le SSP Cloud, il récupère des identifiants lui permettant d'accéder, de manière plus ou moins limitée selon la solution retenue, à votre compte Github et à interagir avec vos dépôts. À ce stade, ce n'est pas une méthode recommandée et si elle est utilisée, il convient d'utiliser un jeton d'accès aux droits limités. La fiche `utilitR` [Configurer Git](https://www.book.utilitr.org/03_fiches_thematiques/fiche_configurer_git) présente plus de détails sur la question des jetons d'accès à Github
**ATTENTION : cette méthode comporte des risques car dans l'éventualité où un attaquant parvient à accéder à votre compte sur le SSP Cloud, il récupère des identifiants lui permettant d'accéder, de manière plus ou moins limitée selon la solution retenue, à votre compte Github et à interagir avec vos dépôts. À ce stade, ce n'est pas une méthode recommandée et si elle est utilisée, il convient d'utiliser un jeton d'accès aux droits limités. La fiche `utilitR` [Configurer Git](https://book.utilitr.org/03_fiches_thematiques/fiche_configurer_git) présente plus de détails sur la question des jetons d'accès à Github

Ainsi, il est possible de récupérer, de manière systématique, son mot de passe ou, de manière un peu plus sécurisée, le token créé sous Github pour communiquer avec le dépôt. La configuration de l'accès de manière automatique peut se configurer en définissant les secrets ci-dessous dans un dossier `utilitr` :

Expand Down
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -17,7 +17,7 @@ Elle a vocation à être validée annuellement afin de produire un guide des bon

Elle prend la forme suivante :

* la documentation principale qui est déployée à l'adresse <https://www.book.utilitr.org/> ;
* la documentation principale qui est déployée à l'adresse <https://book.utilitr.org/> ;
* un guide des bonnes pratiques en `R` déployé à l'adresse <https://www.pratiques.utilitr.org/>

Lorsqu'une version `PDF` sera mise à disposition, un lien direct de téléchargement sera
Expand Down Expand Up @@ -46,7 +46,7 @@ Cette documentation présente succinctement les outils les plus adaptés à ces

### Structuration de la documentation

La documentation présentée dans www.book.utilitr.org a pour ambition de répondre à deux questions générales:
La documentation présentée dans book.utilitr.org a pour ambition de répondre à deux questions générales:

* Comment réaliser des tâches standards avec `R` (importation et manipulation de données, exploitation d'enquêtes, graphiques...)?
* Comment configurer `R` et `Rstudio` de manière à bénéficier de la richesse de cet écosystème ?
Expand Down

0 comments on commit 4ed3f0b

Please sign in to comment.