Pour compiler le livre localement:
- Cloner ce répertoire
- Installer bookdown
- Utiliser bookdown :
bookdown::render_book('index.Rmd', 'bookdown::gitbook')Il y a aussi un makefile pour créer le gitbook :
make gitbook
le epub :
make epub
et le pdf
make pdf
De manière générale, il est utile de vérifier qu'il n'y a pas de problème avec le gitbook, c'est un peu moins important pour le epub qui serait de toute façon créer par Travis.
Toutes les contributions sont les bienvenues 😄 et même très appréciées! Si vous êtes en dehors du groupe inSileco, vous pouvez forker ce répertoire et puis créer un pull request à partir de votre fork. Vous pouvez aussi directement éditer les fichiers en ligne.
Un chapitre est un fichier chapitre.Rmd. Pour en éditer le contenu, l'étendre
ou signaler des erreurs, le plus simple est d'ouvrir un issue en expliquant ce
que vous souhaitez faire ou de détailler l'erreur. Si vous êtes collaborateurs
sur le projet, vous pouvez vous assignez la tâche pour signaler au groupe ce sur
quoi vous travailler. Deux
projets ont été organisés
dans le répertoire GitHub (voir About project
boards pour plus de
détails). Pour les utiliser, il suffit de les mentionner au moment de
l'ouverture d'un nouvel issue est ouvert, on peut en suite les éditer et
suivre leur avancement dans l'onglet project.
Autres remarques:
- ce livre est édité avec bookdown, la documentation est très utile https://bookdown.org/yihui/bookdown/
code/chapN/pour les scripts pour le chapitre N;img/chapN/pour les figures/images non créés avec R pour le chapitre N;extdata/pour les données externes;- ajouter les references dans
book.bib; - suivre les bonnes pratiques pour le code: voir goodpractice
- donner des noms au code chunk afin d'avoir des repères pour faciliter le débogage.