Imaginons que vous stockez tout ce qui se trouve dans votre ordinateur dans un seul et même dossier - certains d'entre vous utilisent probablement leur bureau ou leur dossier de téléchargement à cet effet. Imaginez le temps que cela vous prendrait pour retrouver une donnée précise que vous avez collectée à une journée précise il y a de cela quelques années.
Image par Memed_Nurrohmad de Pixabay
Plutôt que de garder tous nos documents à une seule place, nous les organisons parfois en utilisant un répertoire ou une structure de dossiers particulière. Cette structure nous permet d'économiser du temps en plus d'améliorer notre productivité et notre capacité à collaborer en s'assurant que toutes les personnes désirant trouver un fichier puissent y arriver facilement.
La structure "type" d'un répertoire est généralement composée :
Habituellement, les données, les analyses et les rapports sont séparés en sous-répertoires distincts sous le répertoire principal. La structure ressemble alors à ceci:
├── Dossier-projetX/
| ├── Experience-Donnees/
| | ├── Fichier-1
| | ├── Fichier-2
| ├── Experience-Analyse/
| | ├── Fichier-1
| ├── Experience-Rapport/
| | ├── Fichier-1
| | ├── Fichier-2
À noter!
Les noms des répertoires sont fréquemment suivis d'une barre oblique ( / ) pour les différencier des fichiers.
Question
Dans l'exemple de structure plus haut, lequel est considéré comme le répertoire à la racine? Et lesquels sont des sous-répertoires?
Les fichiers _LISEZMOI (_README) et les dictionnaires de données (data dictionaries) fournissent de brèves descriptions des principaux dossiers, de leur contenu, de la convention de nommage et de la structure des données.
Ces deux documents sont des indispensables afin d'assurer la transparence et la reproductibilité des données, puisqu'ils permettent de facilement comprendre le contenu des répertoires et des données sans devoir passer par le créateur des données.
Image par Mohamed Hassan de Pixabay
Contenu et emplacements de ces fichiers
1. _LISEZMOI : Un premier fichier _LISEZMOI est placé à la racine du répertoire et décrit le contenu de la structure de fichiers. Un 2e fichier est placé dans le sous-répertoire contenant les données et explique comment, où et qui a travaillé sur la collecte des données (Copeland, C., 2021).
2. _DICTIONNAIRE_DONNEES : Placé dans le répertoire contenant les données, il décrit la manière dont les variables des données ont été définies et décrites.
La structure ressemblerait donc à ceci :
├── Dossier-projetX/
| ├── _LISEZMOI.md <--
| ├── Experience-Donnees/
| | ├── _DICTIONNAIRE-DONNEES.md
<--
| | ├──
_LISEZMOI.md <--
| | ├── Fichier-1
| | ├── Fichier-2
| ├── Experience-Analyse/
| | ├── Fichier-1
| ├── Experience-Rapport/
| | ├── Fichier-1
| | ├── Fichier-2
Nommage
Les fichiers _LISEZMOI et les dictionnaires de données devraient être la première chose que l'on voit en ouvrant un répertoire ou un dossier puisqu'ils agissent en tant que guide sur leur contenu. Ces deux fichiers devraient donc :
Format
Les fichiers _LISEZMOI et les dictionnaires de données devraient être écrits en texte brut. Cela permettra à vos fichiers de s'ouvrir sur n'importe quel type d'ordinateur. Il n'est pas rare de voir ces fichiers avec des extensions .txt (texte) ou .md (Markdown documentation).
Image par OpenClipart-Vectors de Pixabay
Vous êtes dans le cours COM110 et vous travaillez sur votre projet de recherche. À l'approche de la remise de votre projet, vous avez des fichiers qui ressemblent à ceci :
Tremblay_20210921_COM110ProjetR_ph-donnees.csv
Tremblay
_20210922_COM110ProjetR_ph-donnees.csv
Tremblay
_20210923_COM110ProjetR_ph-donnees.csv
Tremblay
_20210924_COM110ProjetR_ph-donnees.csv
Tremblay
_COM110ProjetR_Analyse_V0.xlsx
Tremblay
_COM110ProjetR_Figure-freq-plot_V0.png
Tremblay
_COM110ProjetR_Figure-linear-reg_V0.png
Tremblay
_COM110ProjetR_Figure-linear-reg_V1.png
Tremblay
_COM110ProjetR_Lab-rapport_V0.docx
Tremblay
_COM110ProjetR_Lab-rapport_V1.docx
Tremblay
_COM110ProjetR_Lab-rapport_V2.docx
Tremblay
_COM110ProjetR_Lab-rapport_V3.docx
Assumant que ce projet allait être court et simple, aucun fichier descriptif n'a été créé. On peut aussi observer que les fichiers ont été enregistrés au même niveau et que quelques fichiers supplémentaires pourraient rapidement rendre la gestion du projet difficile.
Placez ces fichiers dans un répertoire structuré en suivant ce que nous venons d'apprendre! Vous pouvez copier ce gabarit pour l'exercice :
├── exemple/
| ├── exemple/
| | ├── exemple
Un répertoire de dossiers est une entité en constante évolution. Au fil des jours de votre projet de recherche, votre structure devra s'adapter à vos nouveaux besoins.
Disons qu'au jour 1 de votre projet de recherche, votre répertoire ressemble à ceci :
Après un premier projet pilote, vous avez amassé des données sur les jus préférés des étudiant.e.s et votre répertoire ressemble à ceci au jour 2 :
Vous décidez d'ajouter des jeux de données à votre projet en recherchant la collation préférée des étudiant.e.s tout en poursuivant votre collecte de données sur les jus.
Que devez-vous ajouter à votre structure pour faciliter l'intégration des nouvelles données?
Vous savez maintenant comment créer un répertoire structuré pour vos fichiers!
Vous pouvez maintenant prendre le temps d'organiser vos fichiers personnels ou ceux de votre équipe!
Il faut tout d'abord créer le répertoire à la racine "COM110ProjetR".
COM110ProjetR/
Dans ce répertoire, il y aura un fichier et 4 sous-répertoires:
_LISEZMOI.txt
Donnees/
Analyse/
Figures/
Rapport/
Dans le sous-répertoire des données, il faut créer un dictionnaire de données et un fichier _LISEZMOI
_DICTIONNAIRE-DONNEES.txt
_LISEZMOI.txt
Tremblay_20210921_COM110ProjetR_ph-donnees.csv
Tremblay_20210922_COM110ProjetR_ph-donnees.csv
Tremblay_20210923_COM110ProjetR_ph-donnees.csv
Tremblay_20210924_COM110ProjetR_ph-donnees.csv
La structure finale ressemblera à cela:
Cette page est une traduction et adaptation du guide Introduction to Research Data Management : Directory Structures de UBC Library Research Commons partagé avec la licence CC BY. La gestion des données de recherche (GDR) : Structure de dossiers est sous licence CC BY par la bibliothèque de l'École de technologie supérieure.
L'exercice 2 est une traduction et adaptation de 4.8 Example BIOL 125 du guide Procedures and Guidelines. Directory Structures de UBCO Biology partagé avec la licence CC BY-NC-SA. L'exercice 2 est sous licence CC BY-NC-SA par la bibliothèque de l'École de technologie supérieure.
Copeland, C., Pither, J., Vis-Dunbar, M. (2021). Procedures and Guidelines. Directory Structures. https://ubco-biology.github.io/Procedures-and-Guidelines/directory-structures.html