Versions HTML, PDF et EPUB.

Vers une recherche reproductible : Faire évoluer ses pratiques

Ce livre sur la recherche reproductible a été rédigé à l'occasion d'un book sprint organisé par l'Unité régionale de formation à l'information scientifique et technique de Bordeaux (Urfist) ; en savoir plus : chapitre @ref(D-appendix)

Auteurs

Loïc Desquilbet, Sabrina Granger, Boris Hejblum, Arnaud Legrand, Pascal Pernot, Nicolas Rougier

Facilitatrice : Elisa de Castro Guerra

Citer l'ouvrage

• Version imprimée :

Desquilbet, Loïc, Sabrina Granger, Boris Hejblum, Arnaud Legrand, Pascal Pernot, et Nicolas P. Rougier. Vers une recherche reproductible : Faire évoluer ses pratiques. Bordeaux : Urfist de Bordeaux, 2019. ISBN : 979-10-97595-04-3 ; URL Sudoc (to do)

• Version numérique :

Desquilbet, Loïc, Sabrina Granger, Boris Hejblum, Arnaud Legrand, Pascal Pernot, et Nicolas P. Rougier. Vers une recherche reproductible : Faire évoluer ses pratiques. Bordeaux : Urfist de Bordeaux, 2019. ISBN : 979-10-97595-05-0 ; URL HAL (to do)

• Site web :

Le présent ouvrage se décline aussi sous forme d'un site web, intégrant des montées de version en attendant la prochaine édition du document. Si vous citez cette version évolutive dans des travaux, vous pouvez indiquer la date de consultation du site.

Est-il possible de contribuer, de proposer de nouveaux contenus ?

Ce livre est ouvert aux nouveaux contenus : proposition d'ajout de chapitre, complément de chapitre, références complémentaires, mais aussi questions. Le livre ayant été rédigé collaborativement, les propositions sont étudiées par le collectif des auteurs. En fonction de la nature de vos propositions, vous pourrez être amené.e à être cité.e comme contributeur, ou co-auteur. Vous pouvez soumettre vos propositions via :

• GitHub (Issue)
• email : urfist@u-bordeaux.fr

Licence

Ce(tte) œuvre est mise à disposition selon les termes de la Licence Creative Commons Attribution - Pas d’Utilisation Commerciale - Partage dans les Mêmes Conditions 2.0 France.

Informations internes

Quelques liens utiles sur Markdown

• La syntaxe
• Les citations
• Images, footnotes et autres
• Les références d'un chapitre à l'autre

Quelques liens utiles sur Bookdown

• Bookdown
• Avoir des parties en plus des chapitres
• Des chapitres non numérotés
• Comment visualiser le livre avec Rstudio

Clef de références pour les chapitres :

Syntaxe:

• déclaration: {#clef}
• citation: \@ref(clef)

---

• Chroniques de la non reproductibilité
• 01_preambule.Rmd -> {#A-preambule}
  Préambule
• 02_RR_kezako.Rmd -> {#A-introduction}
  Etat des Lieux
• 03_vis_ma_vie.Rmd -> {#A-personas}
  Retours d'expériences
• 04_questions_cauchemars_recurrents.md -> {#A-cauchermars}
  Symptômes d'une rechercher non reproductible

---

• Sources de non reproductibilité
• 05_acquisition_des_donnees.md -> {#B-data-acquisition}
  Acquisition de l'information
• 06_aspects_computationnels.md -> {#B-code-aspect}
  Programmation et calcul
• 07_donnees_d_entree.md -> {#B-data-input}
  Gestion des données
• 08_aspects_computationnels.md -> {#B-code-aspect}
  Programmation et calcul
• 09_donnees_de_sortie.md -> {#B-data-output}
  Communication des résultats

---

• Solutions de la recherche reproductible
• 10_introduction_partie_3.md -> {#C-intro}
  Le temps des changements ?
• 11_collecte_des_donnees.md -> {#C-data-acquisition}
  Documenter ses pratiques
• 12_format_des_donnees.md -> {#C-data-format}
  Formater et structurer l'information
• 13.5_partage_et_archivage.md -> {#C-data-share}
  Partager ses données, codes et résultats
• 13_outils_de_gestion_de_version.md -> {#C-versioning}
  Versionner, versionner, versionner
• 14_apprendre_a_programmer.md -> {#C-code-learn}
  Appendre à programmer
• 15_rendre_son_code_comprehensible.md -> {#C-code-good}
  Rendre son code compréhensible
• 16_eviter_les_bugs.md -> {#C-code-bugs}
  Chasser les erreurs de programmation
• 17_environnement_logiciel.md -> {#C-code-env}
  Identifier et partager son environnement logiciel
• 18_licence_et_privacy.md -> {#C-licences}
  Sortez couverts!

---

• 19_annexes.md -> {#D-appendix}
• 20_Conventions_ecriture.md -> {#D-convention}

Pour compiler le bookdown

Normalement, ce livre est automatiquement compilé et disponible ici.

Ce document a été rédigé à l'aide de bookdown.

Le paquet bookdown peut s'installer à partir de CRAN ou de Github:

install.packages("bookdown")
# or the development version
# devtools::install_github("rstudio/bookdown")

Pour compiler ce document il est également nécessaire d'avoir pandoc, pandoc-citeproc et une installation latex récente (vous pouvez jeter un oeil à tinytex.

Le document est entièremnt rédigé en markdown (nous n'avions pas besoin d'éxécuter du code R, ce pourquoi bookdown est originellement conçu). Néenmoins, pour conserver la prévisualisation de github, nous avons conservé l'extension .md plutôt que .Rmd. Les liens symboliques avec l'extension .Rmd nécessaires sont créés automatiquement par make qui s'occupe de corriger tout un tas de petites choses au niveau de la bibilographie.

La meilleur façon de compiler ce livre est donc d'exécuter la commande suivante dans votre terminal :

make Rmd

Pour compiler ce livre au format html, il vous suffit de faire:

make html

ou bien en R:

rmarkdown::render_site(output_format = 'bookdown::gitbook', encoding = 'UTF-8')

Pour compiler ce livre au format pdf, il vous suffit de faire:

make pdf

ou bien en R (ou presque...):

rmarkdown::render_site(output_format = 'bookdown::pdf_book', encoding = 'UTF-8')