git clone git@forgemia.inra.fr:migale/quarto.gitDocumentation interne
Olivier Rué 
Le site web déployé
https://documents.migale.inrae.fr est le portail d’accès aux documents générés par les membres de la plateforme Migale.
| URL | Statut | Description |
|---|---|---|
| https://documents.migale.inrae.fr | Page d’accueil | |
| https://documents.migale.inrae.fr/training-materials.html | Liste des supports de formation | |
| https://documents.migale.inrae.fr/news.html | Liste des newsletters | |
| https://documents.migale.inrae.fr/presentations.html | Liste des présentations | |
| https://documents.migale.inrae.fr/analyses.html | Liste des rapports d’analyse | |
| https://documents.migale.inrae.fr/intranet.html | Liste des documents internes |
Présentation du dépôt
Le dépôt est accessible sur la forgeMIA. Pour cloner le dépôt :
Warning
Il n’est pas indispensable d’installer quarto sur sa machine en local, mais c’est préférable pour visualiser le rendu avant de propager ses modifications.
Organisation des documents
Les documents sont rédigés au format qmd.
Ajouter un rapport d’analyse
Les rapports d’analyse sont stockés dans le répertoire posts/analyses/. Chaque rapport a son propre répertoire, qu’il faut anonymiser un minimum en rajoutant 5 chiffres après le nom du projet.
Un template est disponible dans le répertoire
posts/analyses/template/.Une image doit être choisie, être présente dans le répertoire, et indiquée dans le fichier
qmddans le champpreview:Une fois le répertoire d’analyse créé, il sera automatiquement disponible sur la page https://documents.migale.inrae.fr/analyses.html
Cette page ne doit pas être communiquée aux demandeurs, elle donne accès à tous les projets en cours.
- Le fichier
infos.tsvdoit être rempli à chaque étape du projet- réception de la demande
- deadline demandée
- changement de deadline
- réunions
- sauvegarde des données
- réception du questionnaire de satisfaction
- soumission d’un papier
- tout ce qui vous semble pertinent…
Ce fichier est lu par le fichier follow-up.qmd et génèrera la fiche de suivi du projet.
- Les informations générales concernant le projet (demandeur, mots-clés…) sont à renseigner dans le fichier
resources/projects.tsv. C’est à partir de ce fichier que sont créés les documents de synyhèse à propos des projets.
Fin de projet
Une fois le projet terminé, il faut déplacer le répertoire dans un autre dépôt : https://forgemia.inra.fr/migale/backup-data-analysis-reports. Il faut alors remplacer son contenu par :
- un fichier
index.htmlcontenant la redirection vers le nouveau dépôt
<html>
<meta http-equiv="refresh" content="0;url=https://backup-data-analysis-reports-6cf7b2.pages.mia.inra.fr/posts/analyses/holovini-pilote-76384/">
</html>- un fichier
follow-up.html
<html>
<meta http-equiv="refresh" content="0;url=https://backup-data-analysis-reports-6cf7b2.pages.mia.inra.fr/posts/analyses/holovini-pilote-76384/follow-up.html">
</html>Ajouter une news
Ajouter un tutoriel
Ajouter des supports de formation
Pense-bête quarto
Référence à un outil
Pour faire référence à un outil, il faut ajouter une entrée au format bibtex dans le fichier /resources/biblio.bib. Ensuite on peut y faire référence dans les documents avec la syntaxe @toolname (toolname étant l’identifiant de l’entrée bibtex). Exemple:
FROGS @frogs is...FROGS [1] is…
The reference is also added in the References section at teh bottom of the document.
Description d’un outil
Il est possible d’utiliser la bibliothèque iconify pour mettre en avant les outils/packages/banques dont on parle dans les documents. Par exemple:
- seqkit
[2]
**seqkit** {{< iconify mdi tools >}} @seqkit- Silva version 138.1
[3]
**Silva version 138.1** {{< iconify mdi database >}} @silva- phyloseq
[4]
**phyloseq** {{< iconify mdi package-variant >}} @phyloseqLa liste des icônes est disponible ici : https://icon-sets.iconify.design/
Boutons téléchargement
Il est possible avec l’extension downloadthis d’ajouter facilement des boutons pour le téléchargement d’un fichier. Exemple :
{{< downloadthis files/quarto.png >}}Full documentation here: https://shafayetshafee.github.io/downloadthis/example.html
Includes
Il est possible d’insérer du texte venant d’un autre fichier .qmd dans un fichier .qmd. Pour cela on utilise les includes, avec la syntaxe suivante :
::: callout-note
This document is a report of the analyses performed. You will find all the code used to analyze these data. The version of the tools (maybe in code chunks) and their references are indicated, for questions of reproducibility.
:::C’est très pratique pour des blocs génériques comme l’introduction ajoutée au début de chaque rapport d’analyse:
Note
This document is a report of the analyses performed. You will find all the code used to analyze these data. The version of the tools (maybe in code chunks) and their references are indicated, for questions of reproducibility.
References
1. Escudié F, Auer L, Bernard M, Mariadassou M, Cauquil L, Vidal K, et al. FROGS: Find, Rapidly, OTUs with Galaxy Solution. Bioinformatics. 2018;34:1287–94. doi:10.1093/bioinformatics/btx791.
2. Shen W, Le S, Li Y, Hu F. SeqKit: A cross-platform and ultrafast toolkit for FASTA/q file manipulation. PloS one. 2016;11:e0163962.
3. Quast C, Pruesse E, Yilmaz P, Gerken J, Schweer T, Yarza P, et al. The SILVA ribosomal RNA gene database project: Improved data processing and web-based tools. Nucleic acids research. 2012;41:D590–6.
4. McMurdie PJ, Holmes S. Phyloseq: An r package for reproducible interactive analysis and graphics of microbiome census data. PloS one. 2013;8:e61217.
