1.6 Article
The final report is written in article form which is a bit different from a usual report, mainly in its size. The article-report has a maximum number of pages of 4 including all images and references (no appendices!). Contents for this article should be extracted from the lab journal combined with part introduction and part conclusion/ discussion. The sections below describe a template that is available for writing this report and example report(s) will be made available for inspiration. Refer to this chapter again once you start writing the report.
1.6.1 Installing the Article Template
The templates are available in an R package and contains both RMarkdown
and (another layer on top of the actual markup language, yes, another language…) files. RStudio can use templates for a number of documents, including article-templates. These templates can be installed from a package called rticles
by running the install.packages
function (note: might already be installed):
1.6.2 Using the Template
Now that you have the templates package (rticles
) installed you can download and use the template project (ZIP-file) available from here. Download this file to your project folder, extract its contents and open the report-template.Rmd
file contained within the folder in RStudio. Verify that everything is setup correctly by hitting the Knit
button at the top, this should create a PDF version of the report. Note that - somehow - the resulting PDF file is named RJwrapper.pdf
instead of the expected report-template.pdf
. If everything checks out OK you can rename the file to your liking and start editing.
This template is based on the R Journal Submission
template that you can also find in RStudio in the New file -> R Markdown -> From Template
menu. Articles published in the R-journal
are based on this template which you can browse for inspiration at the R Journal Website.
The available template shows an example of segments/ chapters and briefly describes what each section could or should contain. If you want to write your report in the Dutch language, you can create a new file from the template and change the segment names and content to Dutch. There will however still be some headings added by the template in English which is fine with me, but if you want to keep everything Dutch you can either edit the RJournal.sty
file manually (not recommended) or start a new file by yourself and add some nice headings and page options.
The top part of the template (between the dashes ---
) contains some settings that you need to change such as title
, authors
and abstract
. Compare for instance a newly created article from this template with the one offered from the project-repository website.