On s’organise

Mise en situation

  • Vous venez de commencer votre stage, thèse… . . .
  • Dans quelques mois, ou dès maintenant, vous allez analyser des données! . . .
  • Analyses de données… peut vite devenir plus compliquée que nécessaire

Ce que font les étudiants en général…

  • faire un dossier “stage” sur le bureau et tout mettre dedans…
  • Tout mettre en vrac dans “mes documents”
  • D’autres exemples dans la salle?

On s’organise !

  • a priori vous allez faire plusieurs choses pendant votre stage, thèse
    • un rapport biblio
    • ecrire un rapport/une thèse
    • analyses pour le premier chapitre
    • analyses pour le second…

Etape 1: On crée un dossier pour chaque étapes/analyses

mkdir ~/sandbox/monstage

(“~” ça veut dire “/home/bbrachi/”)

Sur windows, créer un dossier dans “Documents” par exemple, ou dans votre dossier utilisateur. (remplacer “/sandbox/” par le dossier que vous souhaitez utiliser) . . .

Dans ce dossier vous allez organiser votre travail par projet ou sous-projet.

Votre premier projet, c’est cette formation.

mkdir ~/sandbox/monstage/initiation_git
mkdir ~/sandbox/monstage/analyse_chapitre1
mkdir ~/sandbox/monstage/rapport

Etape 2: On organise son espace de travail pour le projet

cd ~/sandbox/monstage/initiation_git/
mkdir data
mkdir results
mkdir figures
mkdir scripts

On a créé une arborescence

Les noms de dossier/fichier: EVITER LES ESPACES, ACCENT ET CARACTER SPECIAUX

  • alignement fastq.sh ❌

  • alignement_fastq.sh ✅

  • ./scripts R/préparation échantillons.R ❌

  • ./script_R/preparationEchantillons.Rmd ✅

  • ./script_R/preparation_echantillons.Rmd ✅

Avec le control de version (GIT), pas besoin de créer des dossiers “version1”, “version2” etc… ou des versions avec des dates dans les noms de fichiers.

  • analyse_chapitre1_v1.R ❌
  • analyse_chapitre1_2024-06-01.R ❌
  • analyse_chapitre1.R ✅

Etape 3: On utilise Rmd, quarto ou autre pour documenter son travail

  • si vous utilisez R: Rstudio est recommandé (https://posit.co/downloads/)
  • si autre, ou besoin de flexibilité, travailler sur un serveur distant: Visual code studio (https://code.visualstudio.com)
  • Si vous travailler sur un Genobioinfo (Genotoul)
    • vous pouvez utiliser Rstudio directement sur le serveur avec vos identifiants Genotoul

Etape 3: On utilise Rmd, quarto ou autre pour documenter son travail

Rmd, md, qmd sont des formats “texte” qui permettent de combiner textes, codes, équations, et même d’excuter des blocs de codes (Rmd) et donc de:

  • poser les questions
  • faire les analyses pour répondre à ces questions
  • documenter ses analyses pour répondre à ces questions
  • tirer les conclusions
  • motiver l’analyses suivantes
  • orchestrer des scripts successifs

Une petite intro à Markdown

Markdown est partout et c’est bien pour :

  • sites internet simples
  • Documents
  • Notes
  • Book
  • Presentation
  • utile dans les outils de communications (mail, slack, mattermost, Discord)
  • Documentation (de code ou autre)

Une variante de Markdown: Rmarkdown

  • Variante dediée à l’utilisation de R
  • permet de documenter et lancer du code
  • interface de choix avec R, dans Rstudio
  • avec des pluggins dans VS-CODE


Quelques syntaxes Rmd de bases

Vous retrouverez la “cheat sheet” markdown ici: https://www.markdownguide.org/cheat-sheet/#downloads

### Heading

# H1
## H2
### H3

### Bold

**bold text**

### Italic

*italicized text*

### Blockquote

> blockquote
### Ordered List

1. First item
2. Second item
3. Third item

### Unordered List

- First item
- Second item
- Third item

### Code

`code`

### Horizontal Rule

---

Quelques syntaxes Rmd de bases

### Link

[Markdown Guide](https://www.markdownguide.org)

### Image

![alt text](https://www.markdownguide.org/assets/images/tux.png)

### Table

| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |
### Footnote

Here's a sentence with a footnote. [^1]

[^1]: This is the footnote.

### Definition

term
: definition

Quelques syntaxes Rmd de bases

### Strikethrough

~~The world is flat.~~

### Task List

- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media
### Emoji

That is so funny! :joy:

(See also [Copying and Pasting Emoji](https://www.markdownguide.org/extended-syntax/#copying-and-pasting-emoji))

### Highlight

I need to highlight these ==very important words==.

### Subscript

H~2~O

### Superscript

X^2^

Conclusion

  • Organiser son travail est essentiel pour ne pas se noyer dans les données
  • Créer une arborescence de dossier pour chaque projet/étape
  • Utiliser des formats de fichiers qui permettent de documenter son travail (Rmd, qmd, md)

Retour au menu principal

RETOUR MENU PRINCIPAL