Skip to content

Commit

Permalink
Merge pull request #49 from MTES-MCT/dev
Browse files Browse the repository at this point in the history
Test CI
  • Loading branch information
jengelaere authored Jan 17, 2025
2 parents 93c0175 + c34eea9 commit 16e4d33
Show file tree
Hide file tree
Showing 124 changed files with 3,072 additions and 2,872 deletions.
3 changes: 3 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
^renv$
^renv\.lock$
^\.github$
16 changes: 16 additions & 0 deletions .github/workflows/bookdown-build-and-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Déploiement de parcours_r_module6_publications_reproductibles

on:
push:
branches:
- main
- master

workflow_dispatch:

jobs:
build-and-deploy-bookdown:
name: Build and bookdown
uses: MTES-MCT/parcours-r/.github/workflows/bookdown-build-from-desc-and-deploy.yml@master
with:
r_version: '4.4.1'
14 changes: 14 additions & 0 deletions .github/workflows/bookdown-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Test compilation de parcours_r_module6_publications_reproductibles

on:
pull_request:
branches: [main, master, dev, dev-ci, 36-CI]

workflow_dispatch:

jobs:
build-bookdown:
name: Build bookdown
uses: MTES-MCT/parcours-r/.github/workflows/bookdown-build-from-desc.yml@master
with:
r_version: '4.4.1'
31 changes: 31 additions & 0 deletions .github/workflows/rstudio-image-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Image docker parcours_r_module6_publications_reproductibles

on:
push:
branches:
- main
- master
- dev
- 36-CI
paths:
- .github/workflows/rstudio-image-build.yml
- Dockerfile
- DESCRIPTION

pull_request:
types:
- created
branches:
- main
- master
- dev
paths:
- .github/workflows/rstudio-image-build.yml
- Dockerfile
- DESCRIPTION

workflow_dispatch:

jobs:
build-rstudio-image:
uses: MTES-MCT/parcours-r/.github/workflows/rstudio-image-build.yml@master
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,7 @@
.RData
.Ruserdata
_book
_bookdown_files
_bookdown_files
*.html
support-documents-reproductibles.Rmd
archives_docs_compiles/
22 changes: 0 additions & 22 deletions .travis.yml

This file was deleted.

117 changes: 0 additions & 117 deletions 00_preparation_donnees.R

This file was deleted.

51 changes: 51 additions & 0 deletions 01-get-started.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Bien commencer {#get-started}

## Créer un projet sous Rstudio pour vous permettre de recenser vos travaux.

```{r collecte prez projet rstudio, warning=FALSE, echo=FALSE, results='asis'}
# Utilisation du chapitre de présentation des projets RStudio présent dans https://github.com/MTES-MCT/parcours-r
cat(text = stringi::stri_read_lines("https://raw.githubusercontent.com/MTES-MCT/parcours-r/master/parties_communes/bien_commencer.Rmd", encoding = "UTF-8"), sep = '\n')
```

## Utilisation du package `{savoirfR}`

```{r collecte prez savoirfR, warning=FALSE, echo=FALSE, results='asis'}
# Utilisation du chapitre de présentation de savoirfR présent dans https://github.com/MTES-MCT/parcours-r
a <- knitr::knit_child(text = stringi::stri_read_lines("https://raw.githubusercontent.com/MTES-MCT/parcours-r/master/parties_communes/savoir_faire.Rmd", encoding = "UTF-8"), quiet = TRUE)
cat(a, sep = '\n')
```

## Créer votre arborescence de projet

- Créer un répertoire `/src` où vous mettrez vos scripts R.

- Créer un répertoire `/figures` où vous mettrez vos illustrations issues de R.

## Activer les packages nécessaires

Commencez par rajouter un script dans le répertoire `/src` à votre projet qui commencera par :

- activez l'ensemble des packages nécessaires,

- chargez les données dont vous aurez besoin.

<!--# Mettre à jour la liste des packages après finalisation des exercices -->

```{r all_packages}
```

## Bien structurer ses projets data

Plusieurs documents peuvent vous inspirer sur la structuration de vos projets data par la suite.

En voici quelques uns :

- <https://github.com/pavopax/new-project-template>
- <https://nicercode.github.io/blog/2013-04-05-projects/>
- <https://www.inwt-statistics.com/read-blog/a-meaningful-file-structure-for-r-projects.html>
- <http://projecttemplate.net/architecture.html>

A partir du moment où quelques grands principes sont respectés (un répertoire pour les données brutes en lecture seule par exemple), le reste est surtout une question d'attirance plus forte pour l'une ou l'autre solution. L'important est de vous tenir ensuite à garder toujours la même structure dans vos projets afin de vous y retrouver plus simplement.
Loading

0 comments on commit 16e4d33

Please sign in to comment.