Transformez vos scripts R en documentation Quarto
Un package R qui convertit automatiquement vos scripts R en documents Quarto (.qmd)
💡 L’idée : Générer de la documentation HTML à partir de scripts R commentés
🎯 L’objectif : Garder les scripts les plus propres et familiers tout en les rendant compatibles avec l’éco-système Quarto.
Note
Actuellement en développement - utilisez GitHub
🚀 Essayez immédiatement !
https://quartify.lab.sspcloud.fr/
✅ Aucune installation R requise
✅ Interface web complète
✅ Toutes les fonctionnalités disponibles
Public cible : Utilisateurs préférant une interface graphique et qui utilisent un IDE différent de RStudio
Public cible : Utilisateurs préférant une interface graphique et workflow intégré dans RStudio
Idéal pour : Scripts, automatisation CI/CD…
rtoqmd(
input_file, # Fichier R source
output_file = NULL, # Fichier .qmd de sortie (auto si NULL)
title = "My title", # Titre du document
author = "Your name", # Auteur
theme = NULL, # Thème Quarto
render_html = TRUE, # Générer HTML
output_html_file = NULL,# Fichier .html de sortie (auto si NULL)
open_html = FALSE, # Ouvrir HTML automatiquement
)rtoqmd(
input_file = "mon_script.R",
output_file = "rapport_detaille.qmd",
title = "Analyse statistique des ventes 2024",
author = "Équipe Data Science",
format = "html",
theme = "flatly",
number_sections = TRUE,
render_html = TRUE,
output_html_file = "docs/rapport_ventes_2024.html",
open_html = TRUE
)rtoqmd_dir(
input_dir, # Répertoire contenant les .R
output_dir = NULL, # Répertoire de sortie (défaut: input_dir)
create_book = TRUE, # Créer un Quarto Book ?
author = "Your name", # Auteur
render_html = FALSE, # Générer fichier html
output_html_dir = NULL, # Chemin vers le répertoire de création des html
exclude_pattern = NULL # Pattern pour exclure fichiers
)_book/
├── _quarto.yml # Configuration du livre
├── index.qmd # Page d'accueil
├── chapter1.qmd # Chapitre 1
├── chapter2.qmd # Chapitre 2
└── ...
quartify génère automatiquement cette structure à partir de vos scripts R !
Note
Si absent, quartify utilise le nom du fichier comme titre
Important
Minimum 4 symboles à la fin (#, = ou -)
Warning
Commentaires précédés d’espace ou en fin de ligne restent dans le bloc de code !
Vous pouvez inclure des notes privées ou des commentaires de développement dans vos scripts R qui n’apparaîtront pas dans le rendu final. Les commentaires qui commencent par # immédiatement suivi d’un caractère non-espace sont complètement ignorés :
Installez des snippets de code utiles pour une écriture de script R plus rapide avec install_quartify_snippets().
Après installation et redémarrage de RStudio, vous pouvez utiliser :
header + Tab : Insérer un modèle de métadonnées de documentcallout + Tab : Insérer un modèle de calloutmermaid + Tab : Insérer un modèle de diagramme Mermaidtabset + Tab : Insérer un modèle de tabsetNote
Blocs de texte mis en évidence pour attirer l’attention
Astuce
Conseils et bonnes pratiques
Attention
Points importants nécessitant vigilance
Prérequis
Assurez-vous d’avoir installé le package readr :
install.packages("readr")
Note
Utiliser les balises #| pour les options du chunk
Note
N’applique PAS les modifications, juste une suggestion
⚠️ Attention !
Modifie le fichier R source directement. Faites un backup !
Tip
Parfait pour la revue de code !
apply_styler permet de formater définitivement vos fichiers de scripts R.apply_styler ne fonctionne que si use_styler = TRUE.apply_styler = TRUE mais use_styler = FALSE, vous recevrez un avertissement et le fichier source ne sera pas modifié.cosmo, flatly, journal, litera, lumen, lux, materia, minty, morph, pulse, quartz, sandstone, simplex, sketchy, spacelab, united, vapor, yeti, zephyr
darkly, cyborg, slate, solar, superhero, vapor
Voir ce projet.
variables:
DOCKER_AUTH_CONFIG: >
{"auths": {"${FORGE_REVERSE_HOST}": {"auth": "${ARTIFACTORY_ROBOT_AUTH_TOKEN}"}}}
generate-docs:
image:
name: ${FORGE_REVERSE_HOST}/hub-docker-prod-remote/ddottaagr/quartify:latest
stage: build
script:
- R -e "quartify::rtoqmd_dir('scripts/', render = TRUE)"
artifacts:
paths:
- scripts/**/*.qmd
- scripts/**/*.htmlinst/examples/)📧 GitHub Issues pour questions/bugs
🌟 Star le projet sur GitHub !
🤝 Contributions bienvenues

quartify - De R à Quarto en un clic