D.2 Contenu

Le rapport sert à restituer de façon synthétique les résultats d’une étude scientifique, et les interprétations. Le tout est remis dans le contexte de la bibliographie existante en la synthétisant dans l’introduction et en comparant les résultats avec d’autres études connexes dans la discussion. Il faut garder à l’esprit qu’un lecteur doit comprendre l’intégralité du rapport avec un minimum de connaissances a priori sur l’étude réalisée, mais avec des connaissances générales dans la spécialité. Donc, un rapport sur un sujet biologique est adressé à un lecteur biologiste pour lequel il ne faut pas rappeler les concepts de base dans sa discipline. Par contre, il faut expliquer avec suffisamment de détails comment l’étude a été réalisée dans la section “matériel et méthodes”.

En général, les phrases sont simples, directes, courtes et précises (veuillez à utiliser le vocabulaire adéquat et précis). Les explications sont, autant que possible, linéaires. Evitez les renvois dans différentes autres parties du rapport, si ce n’est pour rappeler un élément évoqué plus haut, ou pour se référer à une figure ou une table. A ce sujet, les figures (dont les images, photos, schémas et graphiques) sont numérotées (Figure 1, Figure 2, …) et accompagnées d’une légende en dessous d’elles. La figure et sa légende doivent être compréhensibles telles quelles. Dans le texte, vous pourrez alors vous référer à la figure, par exemple: “Tel phénomène est observable (voir Fig. 3)”, ou “La Fig. 4 montre …”. idem pour les tableaux qui sont également numérotés (Tableau 1, Tableau 2, …) et légendés, mais au dessus du tableau. Les règles de lisibilité du tableau + légende et de renvoi vers les tableaux sont identiques que pour les figures. Les équations peuvent aussi être numérotées et des renvois de type (eq. 5) peuvent être alors utilisés. Enfin, toute affirmation doit être soit démontrée dans le rapport, soit complétée d’une citation vers un autre document scientifique qui la démontre. La partie bibliographie regroupe la liste de tous les documents qui sont ainsi cités à la fin du rapport.

Veuillez à respecter les notations propres au système métrique international, les abbrévations usuelles dans la discipline, et le droit d’auteur et les licenses si vous voulez citer un passage ou reprendre une illustration provenant d’un autre auteur (sans omettre d’indiquer qui en est l’auteur). Enfin, en vue de rendre le document parfaitement reproductible, vous pouvez indiquer dans les annexes où trouver la source (le document .Rmd) et les données analysées. Vous pouvez également terminer avec un chunk qui renseigne de l’état du système R utilisé, y compris l’ensemble des packages employés. Ce chunk, présenté en annexe, contiendra l’instruction utils::sessionInfo(), ou mieux : xfun::session_info() (version courte) ou devtools::session_info() (version longue). Par exemple :

xfun::session_info()
R version 3.5.3 (2019-03-11)
Platform: x86_64-pc-linux-gnu (64-bit)
Running under: Ubuntu 18.04.2 LTS

Locale:
  LC_CTYPE=en_US.UTF-8       LC_NUMERIC=C              
  LC_TIME=en_US.UTF-8        LC_COLLATE=en_US.UTF-8    
  LC_MONETARY=en_US.UTF-8    LC_MESSAGES=en_US.UTF-8   
  LC_PAPER=en_US.UTF-8       LC_NAME=C                 
  LC_ADDRESS=C               LC_TELEPHONE=C            
  LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C       

Package version:
  acepack_1.4.1       anytime_0.3.3       askpass_1.1        
  assertthat_0.2.1    backports_1.1.3     base64enc_0.1-3    
  BH_1.69.0.1         bookdown_0.9        broom_0.5.2        
  callr_3.2.0         cellranger_1.1.0    chart_1.3.0        
  checkmate_1.9.1     cli_1.1.0           clipr_0.5.0        
  cluster_2.0.8       codetools_0.2-16    colorspace_1.4-1   
  compiler_3.5.3      cowplot_0.9.4       crayon_1.3.4       
  curl_3.3            data.io_1.2.2       data.table_1.12.2  
  datasets_3.5.3      DBI_1.0.0           dbplyr_1.3.0       
  digest_0.6.18       dplyr_0.8.0.1       ellipse_0.4.1      
  ellipsis_0.1.0      evaluate_0.13       fansi_0.4.0        
  flow_1.0.0          forcats_0.4.0       foreign_0.8-71     
  Formula_1.2-3       fs_1.2.7            generics_0.0.2     
  ggplot2_3.1.1       ggplotify_0.0.3     ggpubr_0.2         
  ggrepel_0.8.0       ggsci_2.9           ggsignif_0.5.0     
  glue_1.3.1          graphics_3.5.3      grDevices_3.5.3    
  grid_3.5.3          gridExtra_2.3       gridGraphics_0.3-0 
  gtable_0.3.0        haven_2.1.0         highr_0.8          
  Hmisc_4.2-0         hms_0.4.2           htmlTable_1.13.1   
  htmltools_0.3.6     htmlwidgets_1.3     httr_1.4.0         
  igraph_1.2.4        inline_0.3.15       jsonlite_1.6       
  knitr_1.22          labeling_0.3        lattice_0.20-38    
  latticeExtra_0.6-28 lazyeval_0.2.2      lubridate_1.7.4    
  magrittr_1.5        markdown_0.9        MASS_7.3-51.3      
  Matrix_1.2-17       methods_3.5.3       mgcv_1.8.28        
  mime_0.6            modelr_0.1.4        munsell_0.5.0      
  nlme_3.1-138        nnet_7.3-12         nycflights13_1.0.0 
  openssl_1.3         pillar_1.3.1        pkgconfig_2.0.2    
  plogr_0.2.0         plyr_1.8.4          polynom_1.4.0      
  prettyunits_1.0.2   processx_3.3.0      progress_1.2.0     
  proto_1.0.0         pryr_0.1.4          ps_1.3.0           
  purrr_0.3.2         R6_2.4.0            RApiDatetime_0.0.4 
  RColorBrewer_1.1-2  Rcpp_1.0.1          readr_1.3.1        
  readxl_1.3.1        rematch_1.0.1       reprex_0.2.1       
  reshape2_1.4.3      rlang_0.3.4         rmarkdown_1.12     
  rpart_4.1-13        rstudioapi_0.10     rvcheck_0.1.3      
  rvest_0.3.2         scales_1.0.0        SciViews_1.1.0     
  selectr_0.4.1       splines_3.5.3       stats_3.5.3        
  stringi_1.4.3       stringr_1.4.0       survival_2.44-1.1  
  svMisc_1.1.0        sys_3.1             tibble_2.1.1       
  tidyr_0.8.3         tidyselect_0.2.5    tidyverse_1.2.1    
  tinytex_0.11        tools_3.5.3         tsibble_0.7.0      
  utf8_1.1.4          utils_3.5.3         viridis_0.5.1      
  viridisLite_0.3.0   whisker_0.3.2       withr_2.1.2        
  xfun_0.6            xml2_1.2.0          yaml_2.2.0         

D.2.1 Table des matières

La table des matières est d’une importance capitale pour un long document (mais facultative pour un plus court rapport) afin de présenter la structure de votre oeuvre aux lecteurs. Heureusement, il n’est pas nécessaire de l’écrire manuellement. La table des matières est générée automatiquement dans un rapport R Markdown. L’instruction à ajouter dans le préambule du document R Notebook afin d’obtenir une table des matières est toc: yes (ne l’encodez pas directement, mais sélectionnez l’option Include table of contents dans les options de formattage du document accessibles à partir du bouton engrenage à droite de Preview ou Knit -> Output Options...). Lorsque vous fermerez cette boite de dialogue de configuration, l’entrée ad hoc sera ajoutée pour vous dans le préambule.

Vous pouvez aussi choisir de numéroter vos titres automatiquement. L’instruction à ajouter en plus de toc: yes dans le préambule du document R Notebook afin d’obtenir une table des matières avec des titres numéroté est number_sections: yes. Encore une fois, passez par la boite de dialogue de configuration, et cochez-y l’entrée Number section headings.

Voyez l’animation ci-dessous pour accéder à la boite de dialogue de configuration du document R Markdown/R Notebook.

D.2.2 Introduction

L’introduction d’un rapport (ou d’un mémoire) a pour principal objectif de replacer l’étude scientifique réalisée dans son contexte. La règle la plus importante est qu’un lecteur n’ayant jamais entendu parler de cette étude doit comprendre l’intégralité du rapport. L’introduction doit donc permettre de :

  • Remettre l’expérience dans son contexte,
  • Décrire l’organisme étudié + caractéristiques générales de l’organisme, distribution géographique, biotope,…

Notez que l’ajout d’images ou d’une carte de distribution est un plus dans l’introduction.

D.2.3 But

Le but permet de synthétiser la question posée dans cette étude en fonction du contexte de l’expérience expliqué dans l’introduction.

D.2.4 Matériel & méthodes

La section matériel & méthodes permet de décrire les aspects techniques de l’étude comme le matériel employé et les méthodes mises en oeuvre (protocoles des manipulations et des mesures effectuées) afin d’acquérir les données. Cette section est également le lieu de description des techniques statistiques utilisées pour analyser les données, des programmes informatiques employés, …

D.2.5 Résultats

Les résultats vont généralement contenir deux parties :

  • La description des données, via l’exploration des données récoltées (avec graphiques et/ou estimateurs statistiques)
  • L’application des outils statistiques pertinents pour répondre à la question posée

D.2.6 Discussion

Cette section comprend l’interprétation biologique des résultats et la remise dans un contexte plus général, notamment en les comparant à des observations connexes réalisées par d’autres auteurs scientifiques. Il est d’une importance capitale d’avoir un regard critique sur les résultats obtenus. Cette mise en contexte aide en ce sens.

D.2.7 Conclusion(s)

Cette section va résumer les principales implications à retenir de notre étude et, éventuellement, proposer des perspectives afin de poursuivre la recherche dans cette thématique.

D.2.8 Bibliographie (ou références)

La rédaction de travaux s’appuye toujours sur une recherche bibliographique au préalable. CIl faut documenter convenablement les sources bibliographiques au sein de cette section afin d’éviter le plagiat volontaire ou involontaire. Une multitude de programmes existent pour faciliter la gestion de votre base de données bibliographique comme Mendeley, Zotero ou encore Endnote.

  • Pour générer correctement ses références bibliographiques dans un document R Markdown/R Notebook, consulter ceci. Il s’agit d’un manuel en anglais de RStudio qui explique comment faire dans le détail.