Title: | Markdown Templates for INBO |
---|---|
Description: | Several templates to generate reports, presentations and posters. |
Authors: | Thierry Onkelinx [aut, cre] (<https://orcid.org/0000-0001-8804-4216>, Research Institute for Nature and Forest (INBO)), Floris Vanderhaeghe [ctb] (<https://orcid.org/0000-0002-6378-6229>, Research Institute for Nature and Forest (INBO)), Els Lommelen [ctb] (<https://orcid.org/0000-0002-3481-5684>, Research Institute for Nature and Forest (INBO)), Research Institute for Nature and Forest (INBO) [cph, fnd] |
Maintainer: | Thierry Onkelinx <[email protected]> |
License: | GPL-3 |
Version: | 0.6.3 |
Built: | 2024-12-10 04:13:49 UTC |
Source: | https://github.com/inbo/inbomd |
This function will interactively add the information of an author from the local authors database.
add_author(path = ".")
add_author(path = ".")
path |
the path to the |
Other utils:
add_report_numbers()
,
check_dependencies()
,
column_start()
,
column_width()
,
cover_info()
,
create_report()
,
dyn_table()
,
references()
,
render_natbib()
,
validate_doi()
Add the report numbers to a bookdown report
add_report_numbers( path = ".", doi, year, reportnr, depotnr, photo, description, embargo = Sys.Date(), ordernr, copies, motivation, pages )
add_report_numbers( path = ".", doi, year, reportnr, depotnr, photo, description, embargo = Sys.Date(), ordernr, copies, motivation, pages )
path |
the path to the |
doi |
a string containing the DOI. |
year |
Publication year |
reportnr |
Report number assigned by the INBO library. |
depotnr |
Report number assigned by the INBO library. |
photo |
Link to an image to used on the cover. |
description |
Description of |
embargo |
The earliest date at which the report can be made public on the INBO website. Defaults to today. |
ordernr |
Optional reference number specified by the client. |
copies |
Set the required number of copies in case you really need a printed version of the report. Omit in case you only require a digital version. Keep in mind that the INBO policy is to be "radically digital". Which implies to only print a report if it is mandatory. |
motivation |
Required motivation in case |
pages |
Number of pages of the report.
Only required in case |
Other utils:
add_author()
,
check_dependencies()
,
column_start()
,
column_width()
,
cover_info()
,
create_report()
,
dyn_table()
,
references()
,
render_natbib()
,
validate_doi()
Check if the required dependencies of INBOmd are installed Missing dependencies will be installed automatically
check_dependencies()
check_dependencies()
Other utils:
add_author()
,
add_report_numbers()
,
column_start()
,
column_width()
,
cover_info()
,
create_report()
,
dyn_table()
,
references()
,
render_natbib()
,
validate_doi()
Calculate the starting position of an A0 column
column_start(number = 3, start = 1, margin = 20, edge = 10)
column_start(number = 3, start = 1, margin = 20, edge = 10)
number |
The desired number of columns with equal width. |
start |
the number of the column |
margin |
the horizontal distance between columns in mm. |
edge |
the width of the whitespace edge around the poster in mm. |
Other utils:
add_author()
,
add_report_numbers()
,
check_dependencies()
,
column_width()
,
cover_info()
,
create_report()
,
dyn_table()
,
references()
,
render_natbib()
,
validate_doi()
Calculate the width of an A0 column
column_width(number = 3, margin = 20, edge = 10)
column_width(number = 3, margin = 20, edge = 10)
number |
The desired number of columns with equal width. |
margin |
the horizontal distance between columns in mm. |
edge |
the width of the whitespace edge around the poster in mm. |
Other utils:
add_author()
,
add_report_numbers()
,
check_dependencies()
,
column_start()
,
cover_info()
,
create_report()
,
dyn_table()
,
references()
,
render_natbib()
,
validate_doi()
You need to provide information to create the cover image and (optionally)
print the report.
Add the information to the YAML header of the report.
Then run this function to covert the information into a cover.txt
and
send that file along the other files to the review process.
cover_info(path = "index.Rmd")
cover_info(path = "index.Rmd")
path |
The path to the main |
Other utils:
add_author()
,
add_report_numbers()
,
check_dependencies()
,
column_start()
,
column_width()
,
create_report()
,
dyn_table()
,
references()
,
render_natbib()
,
validate_doi()
Create a template for an INBOmd bookdown report
create_report(path = ".", shortname)
create_report(path = ".", shortname)
path |
The folder in which to create the folder containing the report. Defaults to the current working directory. |
shortname |
The name of the report project.
The location of the folder |
Other utils:
add_author()
,
add_report_numbers()
,
check_dependencies()
,
column_start()
,
column_width()
,
cover_info()
,
dyn_table()
,
references()
,
render_natbib()
,
validate_doi()
interactive session: DT::datatable()
html: DT::datatable()
other: knitr::kable()
dyn_table(x, caption = NULL, rownames = FALSE, escape = TRUE, align, ...)
dyn_table(x, caption = NULL, rownames = FALSE, escape = TRUE, align, ...)
x |
the dataframe |
caption |
the table caption; a character vector or a tag object
generated from |
rownames |
|
escape |
whether to escape HTML entities in the table: |
align |
Column alignment: a character vector consisting of |
... |
Other arguments (see Examples and References). |
Other utils:
add_author()
,
add_report_numbers()
,
check_dependencies()
,
column_start()
,
column_width()
,
cover_info()
,
create_report()
,
references()
,
render_natbib()
,
validate_doi()
A version of bookdown::epub_book()
with a different styling.
epub_book()
epub_book()
title
: the main title
subtitle
: the optional subtitle
author
: the authors formatted as indicated in the section below.
flandersfont
: if set to TRUE
, use the Flanders Art Sans font.
When not set, or set to FALSE
or empty, use the Calibri font.
style
: Defaults to "INBO" when missing.
"INBO"
for the INBO style.
"Vlaanderen"
for the generic style of the Flemish Government in
Dutch.
"Flanders"
for the generic style of the Flemish Government in a
language other than Dutch.
lang
: the main language of the document as RFC 5646 tags.
style
"INBO"
and "Vlaanderen"
require "nl"
as lang
.
style
"Flanders"
uses "en"
as default and can use other languages
(but not "nl"
).
"nl"
for Dutch
"en"
for English
"fr"
for French
codesize
: Relative size of R code compared to normal text.
Defaults to "footnotesize"
.
All options going from large to small are: "normalsize"
, "small"
,
"footnotesize"
, "scriptsize"
, "tiny"
.
"normalsize"
implies the same size as normal text.
Quotes are required when a part contains spaces.
If the author doesn't have an ORCID, you can omit that line.
However, note that the INBO policy is that all scientific personnel is
required to obtain an ORCID from https://orcid.org.
Add corresponding: true
to the corresponding author.
- name: given: "Authors first name" family: "Authors last name" email: "[email protected]" orcid: 0000-0002-1825-0097 corresponding: true
Bold items are required when creating a public report. Omitting them results in an ugly warning in the rendered document. This is deliberate done so you can prepare the document without adding the information. But the ugly warnings nudges you to add the required information before publication.
public_report
: A logical value indicating whether the report will be
published or not.
Setting public_report: FALSE
will alter the colophon.
Omitting public_report
is equivalent to public_report: TRUE
.
An internal report can't have a DOI.
Setting a DOI is equivalent to public_report: TRUE
.
reviewer
: names of the reviewers.
Use the same syntax as for the authors.
year
: year of publication.
Used in the same places as shortauthor
.
cover_photo
: the relative path to the image you want on the cover.
cover_description
: Description of the cover photo, including
information on the author of the picture and license information.
cover
the relative path to a pdf with the cover provided by the graphical
designer.
The first page of this pdf will be prepended to the pdf version of the
report.
It becomes the title page in the web and e-book version of the report.
And also shows as a thumbnail in the floating table of content in the web
version.
doi
: the Digital Object Identifier of the report.
Used in conjunction with shortauthor
and year
.
reportnr
: Report number assigned by the INBO library.
ordernr
: Optional reference number specified by the client.
depotnr
: Report number assigned by the INBO library.
client
: Optionally the name, address and website of the client.
client_logo
: Optionally the logo of the client.
Only used when client
is set.
cooperation
: Optionally the name, address and website of the organisation
you collaborated with.
cooperation_logo
: Optionally the logo of the collaborator.
Only used when cooperation
is set.
geraardsbergen
: Set this to TRUE
to add the address of INBO
Geraardsbergen to the colophon.
If not set or set to FALSE
add the address of INBO Brussels.
watermark
: an optional text to display as a watermark on the pdf or html.
Note that omitting any of the required element will automatically generate
a watermark with the text "DRAFT"
.
Fill all required fields to get ride of this automatic watermark.
Other output:
gitbook()
,
handouts()
,
minutes()
,
mission()
,
pdf_report()
,
poster()
,
slides()
A version of bookdown::gitbook()
with a different styling.
gitbook(code_folding = c("none", "show", "hide"))
gitbook(code_folding = c("none", "show", "hide"))
code_folding |
Enable document readers to toggle the display of R code
chunks. Specify |
title
: the main title
subtitle
: the optional subtitle
author
: the authors formatted as indicated in the section below.
flandersfont
: if set to TRUE
, use the Flanders Art Sans font.
When not set, or set to FALSE
or empty, use the Calibri font.
style
: Defaults to "INBO" when missing.
"INBO"
for the INBO style.
"Vlaanderen"
for the generic style of the Flemish Government in
Dutch.
"Flanders"
for the generic style of the Flemish Government in a
language other than Dutch.
lang
: the main language of the document as RFC 5646 tags.
style
"INBO"
and "Vlaanderen"
require "nl"
as lang
.
style
"Flanders"
uses "en"
as default and can use other languages
(but not "nl"
).
"nl"
for Dutch
"en"
for English
"fr"
for French
codesize
: Relative size of R code compared to normal text.
Defaults to "footnotesize"
.
All options going from large to small are: "normalsize"
, "small"
,
"footnotesize"
, "scriptsize"
, "tiny"
.
"normalsize"
implies the same size as normal text.
Quotes are required when a part contains spaces.
If the author doesn't have an ORCID, you can omit that line.
However, note that the INBO policy is that all scientific personnel is
required to obtain an ORCID from https://orcid.org.
Add corresponding: true
to the corresponding author.
- name: given: "Authors first name" family: "Authors last name" email: "[email protected]" orcid: 0000-0002-1825-0097 corresponding: true
Bold items are required when creating a public report. Omitting them results in an ugly warning in the rendered document. This is deliberate done so you can prepare the document without adding the information. But the ugly warnings nudges you to add the required information before publication.
public_report
: A logical value indicating whether the report will be
published or not.
Setting public_report: FALSE
will alter the colophon.
Omitting public_report
is equivalent to public_report: TRUE
.
An internal report can't have a DOI.
Setting a DOI is equivalent to public_report: TRUE
.
reviewer
: names of the reviewers.
Use the same syntax as for the authors.
year
: year of publication.
Used in the same places as shortauthor
.
cover_photo
: the relative path to the image you want on the cover.
cover_description
: Description of the cover photo, including
information on the author of the picture and license information.
cover
the relative path to a pdf with the cover provided by the graphical
designer.
The first page of this pdf will be prepended to the pdf version of the
report.
It becomes the title page in the web and e-book version of the report.
And also shows as a thumbnail in the floating table of content in the web
version.
doi
: the Digital Object Identifier of the report.
Used in conjunction with shortauthor
and year
.
reportnr
: Report number assigned by the INBO library.
ordernr
: Optional reference number specified by the client.
depotnr
: Report number assigned by the INBO library.
client
: Optionally the name, address and website of the client.
client_logo
: Optionally the logo of the client.
Only used when client
is set.
cooperation
: Optionally the name, address and website of the organisation
you collaborated with.
cooperation_logo
: Optionally the logo of the collaborator.
Only used when cooperation
is set.
geraardsbergen
: Set this to TRUE
to add the address of INBO
Geraardsbergen to the colophon.
If not set or set to FALSE
add the address of INBO Brussels.
watermark
: an optional text to display as a watermark on the pdf or html.
Note that omitting any of the required element will automatically generate
a watermark with the text "DRAFT"
.
Fill all required fields to get ride of this automatic watermark.
gitbook
github-repo
: You can optionally set the github
repo in
organisation/repository
format (e.g. inbo/INBOmd
).
This will add an 'edit' button to the source file on GitHub.
Note that only people with write access can edit the files directly in the
repository.
Others can only edit the source code in a fork of the repository and
suggest the changes through a pull request.
split_by
: How to name the HTML output files from the book:
chapter+number
means split the file by the first-level headers;
section+number
means the second-level headers.
For chapter+number
and section+number
, the HTML file names
will be determined by the header ID's, e.g. the file name for the first
chapter with a chapter title # Introduction
will be
‘1-introduction.html’.
Note that you need to place at least one level 1 heading in index.Rmd
.
Otherwise you don't get an index.html
file.
Other output:
epub_book()
,
handouts()
,
minutes()
,
mission()
,
pdf_report()
,
poster()
,
slides()
Similar to slides()
except that you can't have progressive slides.
And you can place multiple slides on a single page.
handouts( toc = TRUE, nup = c("8", "1", "1plus", "2", "3", "3plus", "4", "4plus", "6"), ... )
handouts( toc = TRUE, nup = c("8", "1", "1plus", "2", "3", "3plus", "4", "4plus", "6"), ... )
toc |
display a table of content after the title slide |
nup |
Number of slides on a page.
Defaults to |
... |
currently ignored |
title
: the main title
subtitle
: the optional subtitle
author
: the authors formatted as indicated in the section below.
flandersfont
: if set to TRUE
, use the Flanders Art Sans font.
When not set, or set to FALSE
or empty, use the Calibri font.
style
: Defaults to "INBO" when missing.
"INBO"
for the INBO style.
"Vlaanderen"
for the generic style of the Flemish Government in
Dutch.
"Flanders"
for the generic style of the Flemish Government in a
language other than Dutch.
lang
: the main language of the document as RFC 5646 tags.
style
"INBO"
and "Vlaanderen"
require "nl"
as lang
.
style
"Flanders"
uses "en"
as default and can use other languages
(but not "nl"
).
"nl"
for Dutch
"en"
for English
"fr"
for French
codesize
: Relative size of R code compared to normal text.
Defaults to "footnotesize"
.
All options going from large to small are: "normalsize"
, "small"
,
"footnotesize"
, "scriptsize"
, "tiny"
.
"normalsize"
implies the same size as normal text.
Quotes are required when a part contains spaces.
If the author doesn't have an ORCID, you can omit that line.
However, note that the INBO policy is that all scientific personnel is
required to obtain an ORCID from https://orcid.org.
Add corresponding: true
to the corresponding author.
- name: given: "Authors first name" family: "Authors last name" email: "[email protected]" orcid: 0000-0002-1825-0097 corresponding: true
location
: optional text placed on the title slide below the (sub)title.
institute
: optional text placed on the title slide below the author.
toc
: add a slide with the table of content.
Defaults to TRUE
.
toc_name
: slide title for the table of content.
Defaults to Overzicht
when missing.
cover_photo
: the relative path to the image you want on the cover.
When missing, you get a default picture.
cover_horizontal
: When omitted, scale the cover_photo
so that it covers
the full page vertically.
When set to any value but FALSE
or empty, scale the cover_photo
so that
it covers the full page horizontally.
cover_offset
: A measurement like 8mm
or -1.5cm
.
Positive values move the cover_photo
upwards on the title slide.
Negative values move the cover_photo
downwards.
cover_hoffset
: Similar as cover_offset
but moves cover_photo
horizontally.
Positive values move it to the right, negative values to the left.
aspect
: the required aspect ratio for the slides.
Defaults to "16:9".
See the section below for a list of the available aspect ratios.
fontsize
: Size of the normal text on the slides.
Other elements are scaled accordingly.
Defaults to "11pt".
See the section Aspect_ratio for more details.
website
: URL in the sidebar.
Defaults to vlaanderen.be/inbo
.
The table below lists the available aspect ratios and their "paper size". The main advantage of using a small “paper size” is that you can use all your normal fonts at their natural sizes. E.g. an 11pt font on a slide is as readable as an 11pt font on a A4 paper.
aspect | ratio | width | height |
16:9 | 1.78 | 160.0 mm | 90 mm |
16:10 | 1.60 | 160.0 mm | 100 mm |
14:9 | 1.56 | 140.0 mm | 90 mm |
3:2 | 1.50 | 135.0 mm | 90 mm |
1.4:1 | 1.41 | 148.5 mm | 105 mm |
4:3 | 1.33 | 128.0 mm | 96 mm |
5:4 | 1.25 | 125.0 mm | 100 mm |
Other output:
epub_book()
,
gitbook()
,
minutes()
,
mission()
,
pdf_report()
,
poster()
,
slides()
.Rmd
file.
A markdown block will be display as a frame with a title in a different
background.
There are 3 types of blocks: "block"
, "exampleblock"
and "alertblock"
.Insert a markdown block
These functions will add template chunks into your .Rmd
file.
A markdown block will be display as a frame with a title in a different
background.
There are 3 types of blocks: "block"
, "exampleblock"
and "alertblock"
.
insert_block() insert_exampleblock() insert_alertblock()
insert_block() insert_exampleblock() insert_alertblock()
old function | new function |
ìnbo_ebook() |
epub_book() |
ìnbo_handouts() |
handouts() |
ìnbo_poster() |
poster() |
ìnbo_rapport() |
pdf_report() |
inbo_rapport_css() |
report_template() |
ìnbo_slides() |
slides() |
ìnbo_verslag() |
minutes() |
report() |
pdf_report() |
kolom_breedte(aantal = 3, marge = 20, witruimte = 10) kolom_start(aantal = 3, start = 1, marge = 20, witruimte = 10) ebook() inbo_ebook() inbo_handouts( toc = TRUE, nup = c("8", "1", "1plus", "2", "3", "3plus", "4", "4plus", "6"), ... ) inbo_rapport_css(format = "html") inbo_verslag( present = "", absent = "", chair = "", floatbarrier = c(NA, "section", "subsection", "subsubsection"), includes = NULL, codesize = c("footnotesize", "scriptsize", "tiny", "small", "normalsize"), lang = "dutch", keep_tex = FALSE, fig_crop = TRUE, pandoc_args = NULL, ... ) inbo_zending( conference, conferencedate, conferenceplace, website = "", reportdate, colleagues = "", floatbarrier = c(NA, "section", "subsection", "subsubsection"), includes = NULL, codesize = c("footnotesize", "scriptsize", "tiny", "small", "normalsize"), lang = "dutch", keep_tex = FALSE, fig_crop = TRUE, pandoc_args = NULL, ... ) inbo_rapport(fig_crop = "auto", includes = NULL, pandoc_args = NULL, ...) report(fig_crop = "auto", includes = NULL, pandoc_args = NULL, ...) inbo_poster( subtitle, codesize = c("footnotesize", "scriptsize", "tiny", "small", "normalsize"), lang = "english", email = "[email protected]", keep_tex = FALSE, fig_crop = TRUE, includes = NULL, pandoc_args = NULL, ... ) inbo_slides(toc = TRUE, ...)
kolom_breedte(aantal = 3, marge = 20, witruimte = 10) kolom_start(aantal = 3, start = 1, marge = 20, witruimte = 10) ebook() inbo_ebook() inbo_handouts( toc = TRUE, nup = c("8", "1", "1plus", "2", "3", "3plus", "4", "4plus", "6"), ... ) inbo_rapport_css(format = "html") inbo_verslag( present = "", absent = "", chair = "", floatbarrier = c(NA, "section", "subsection", "subsubsection"), includes = NULL, codesize = c("footnotesize", "scriptsize", "tiny", "small", "normalsize"), lang = "dutch", keep_tex = FALSE, fig_crop = TRUE, pandoc_args = NULL, ... ) inbo_zending( conference, conferencedate, conferenceplace, website = "", reportdate, colleagues = "", floatbarrier = c(NA, "section", "subsection", "subsubsection"), includes = NULL, codesize = c("footnotesize", "scriptsize", "tiny", "small", "normalsize"), lang = "dutch", keep_tex = FALSE, fig_crop = TRUE, pandoc_args = NULL, ... ) inbo_rapport(fig_crop = "auto", includes = NULL, pandoc_args = NULL, ...) report(fig_crop = "auto", includes = NULL, pandoc_args = NULL, ...) inbo_poster( subtitle, codesize = c("footnotesize", "scriptsize", "tiny", "small", "normalsize"), lang = "english", email = "[email protected]", keep_tex = FALSE, fig_crop = TRUE, includes = NULL, pandoc_args = NULL, ... ) inbo_slides(toc = TRUE, ...)
aantal |
The desired number of columns with equal width. |
marge |
the horizontal distance between columns in mm. |
witruimte |
the width of the whitespace edge around the poster in mm. |
start |
the number of the column |
toc |
display a table of content after the title slide |
nup |
Number of slides on a page.
Defaults to |
... |
currently ignored |
format |
defunct |
present |
names of all persons who attended the meeting |
absent |
names of all persons who couldn't make it |
chair |
chair of the meeting |
floatbarrier |
where to place automatic float barriers. |
includes |
Named list of additional content to include within the
document (typically created using the |
codesize |
relative font size for code |
lang |
main language |
keep_tex |
Keep the intermediate tex file used in the conversion to PDF.
Note that this argument does not control whether to keep the auxiliary
files (e.g., ‘.aux’) generated by LaTeX when compiling ‘.tex’ to
‘.pdf’. To keep these files, you may set |
fig_crop |
Whether to crop PDF figures with the command
|
pandoc_args |
Additional command line options to pass to pandoc |
conference |
the name of the conference or workshop |
conferencedate |
the date of the conference |
conferenceplace |
the location of the conference |
website |
the website of the conference |
reportdate |
the date of this report |
colleagues |
name of other colleagues attending the same conference |
subtitle |
An optional subtitle |
email |
The email address to display at the bottom.
Defaults to |
Create a minutes of a meeting with the INBO corporate identity
minutes( present = "", absent = "", chair = "", floatbarrier = c(NA, "section", "subsection", "subsubsection"), includes = NULL, codesize = c("footnotesize", "scriptsize", "tiny", "small", "normalsize"), lang = "dutch", keep_tex = FALSE, fig_crop = TRUE, pandoc_args = NULL, ... )
minutes( present = "", absent = "", chair = "", floatbarrier = c(NA, "section", "subsection", "subsubsection"), includes = NULL, codesize = c("footnotesize", "scriptsize", "tiny", "small", "normalsize"), lang = "dutch", keep_tex = FALSE, fig_crop = TRUE, pandoc_args = NULL, ... )
present |
names of all persons who attended the meeting |
absent |
names of all persons who couldn't make it |
chair |
chair of the meeting |
floatbarrier |
where to place automatic float barriers. |
includes |
Named list of additional content to include within the
document (typically created using the |
codesize |
relative font size for code |
lang |
main language |
keep_tex |
Keep the intermediate tex file used in the conversion to PDF.
Note that this argument does not control whether to keep the auxiliary
files (e.g., ‘.aux’) generated by LaTeX when compiling ‘.tex’ to
‘.pdf’. To keep these files, you may set |
fig_crop |
Whether to crop PDF figures with the command
|
pandoc_args |
Additional command line options to pass to pandoc |
... |
extra parameters: see details |
Available extra parameters:
hyphenation: the correct hyphenation for certain words
Other output:
epub_book()
,
gitbook()
,
handouts()
,
mission()
,
pdf_report()
,
poster()
,
slides()
Create a mission report with the INBO corporate identity
mission( conference, conferencedate, conferenceplace, website = "", reportdate, colleagues = "", floatbarrier = c(NA, "section", "subsection", "subsubsection"), includes = NULL, codesize = c("footnotesize", "scriptsize", "tiny", "small", "normalsize"), lang = "dutch", keep_tex = FALSE, fig_crop = TRUE, pandoc_args = NULL, ... )
mission( conference, conferencedate, conferenceplace, website = "", reportdate, colleagues = "", floatbarrier = c(NA, "section", "subsection", "subsubsection"), includes = NULL, codesize = c("footnotesize", "scriptsize", "tiny", "small", "normalsize"), lang = "dutch", keep_tex = FALSE, fig_crop = TRUE, pandoc_args = NULL, ... )
conference |
the name of the conference or workshop |
conferencedate |
the date of the conference |
conferenceplace |
the location of the conference |
website |
the website of the conference |
reportdate |
the date of this report |
colleagues |
name of other colleagues attending the same conference |
floatbarrier |
where to place automatic float barriers. |
includes |
Named list of additional content to include within the
document (typically created using the |
codesize |
relative font size for code |
lang |
main language |
keep_tex |
Keep the intermediate tex file used in the conversion to PDF.
Note that this argument does not control whether to keep the auxiliary
files (e.g., ‘.aux’) generated by LaTeX when compiling ‘.tex’ to
‘.pdf’. To keep these files, you may set |
fig_crop |
Whether to crop PDF figures with the command
|
pandoc_args |
Additional command line options to pass to pandoc |
... |
extra parameters: see details |
Available extra parameters:
hyphenation: the correct hyphenation for certain words
Other output:
epub_book()
,
gitbook()
,
handouts()
,
minutes()
,
pdf_report()
,
poster()
,
slides()
Create a report with the Flemish corporate identity
pdf_report(fig_crop = "auto", includes = NULL, pandoc_args = NULL, ...)
pdf_report(fig_crop = "auto", includes = NULL, pandoc_args = NULL, ...)
fig_crop |
Whether to crop PDF figures with the command
|
includes |
Named list of additional content to include within the
document (typically created using the |
pandoc_args |
Additional command line options to pass to pandoc |
... |
currently ignored |
title
: the main title
subtitle
: the optional subtitle
author
: the authors formatted as indicated in the section below.
flandersfont
: if set to TRUE
, use the Flanders Art Sans font.
When not set, or set to FALSE
or empty, use the Calibri font.
style
: Defaults to "INBO" when missing.
"INBO"
for the INBO style.
"Vlaanderen"
for the generic style of the Flemish Government in
Dutch.
"Flanders"
for the generic style of the Flemish Government in a
language other than Dutch.
lang
: the main language of the document as RFC 5646 tags.
style
"INBO"
and "Vlaanderen"
require "nl"
as lang
.
style
"Flanders"
uses "en"
as default and can use other languages
(but not "nl"
).
"nl"
for Dutch
"en"
for English
"fr"
for French
codesize
: Relative size of R code compared to normal text.
Defaults to "footnotesize"
.
All options going from large to small are: "normalsize"
, "small"
,
"footnotesize"
, "scriptsize"
, "tiny"
.
"normalsize"
implies the same size as normal text.
Quotes are required when a part contains spaces.
If the author doesn't have an ORCID, you can omit that line.
However, note that the INBO policy is that all scientific personnel is
required to obtain an ORCID from https://orcid.org.
Add corresponding: true
to the corresponding author.
- name: given: "Authors first name" family: "Authors last name" email: "[email protected]" orcid: 0000-0002-1825-0097 corresponding: true
Bold items are required when creating a public report. Omitting them results in an ugly warning in the rendered document. This is deliberate done so you can prepare the document without adding the information. But the ugly warnings nudges you to add the required information before publication.
public_report
: A logical value indicating whether the report will be
published or not.
Setting public_report: FALSE
will alter the colophon.
Omitting public_report
is equivalent to public_report: TRUE
.
An internal report can't have a DOI.
Setting a DOI is equivalent to public_report: TRUE
.
reviewer
: names of the reviewers.
Use the same syntax as for the authors.
year
: year of publication.
Used in the same places as shortauthor
.
cover_photo
: the relative path to the image you want on the cover.
cover_description
: Description of the cover photo, including
information on the author of the picture and license information.
cover
the relative path to a pdf with the cover provided by the graphical
designer.
The first page of this pdf will be prepended to the pdf version of the
report.
It becomes the title page in the web and e-book version of the report.
And also shows as a thumbnail in the floating table of content in the web
version.
doi
: the Digital Object Identifier of the report.
Used in conjunction with shortauthor
and year
.
reportnr
: Report number assigned by the INBO library.
ordernr
: Optional reference number specified by the client.
depotnr
: Report number assigned by the INBO library.
client
: Optionally the name, address and website of the client.
client_logo
: Optionally the logo of the client.
Only used when client
is set.
cooperation
: Optionally the name, address and website of the organisation
you collaborated with.
cooperation_logo
: Optionally the logo of the collaborator.
Only used when cooperation
is set.
geraardsbergen
: Set this to TRUE
to add the address of INBO
Geraardsbergen to the colophon.
If not set or set to FALSE
add the address of INBO Brussels.
watermark
: an optional text to display as a watermark on the pdf or html.
Note that omitting any of the required element will automatically generate
a watermark with the text "DRAFT"
.
Fill all required fields to get ride of this automatic watermark.
Bold items are required. Omitting them results in an ugly warning in the rendered document. This is deliberate done so you can prepare the document without adding the information. But the ugly warnings nudges you to add the required information before publication.
embargo
: The date at which the report is made public on the INBO
website.
print
: section only required in case you need a number of printed copies.
When set it requires the following sub items:
copies
: the number of copies
motivation
: motivate why you need printed copies as the INBO policy
is to use only digital publications.
pages
: the number of pages in the full document.
tocdepth
: which level headers to display.
0: up to chapters (#
)
1: up to section (##
) default
2: up to subsection (###
)
lof
: Adds a list of figures to the pdf after the table of content when
set to TRUE
.
Omits the list of figures when missing or set to FALSE
.
lot
: Adds a list of tables to the pdf after the table of content and the
list of figures when set to TRUE
.
Omits the list of tables when missing or set to FALSE
.
hyphenation
: An optional list of words with a specified hyphenation
pattern.
E.g. hyphenation: "fortran, ergo-no-mic"
forces the word "fortran"
to
remain as a single word.
"ergonomic" can be either the entire word, split into "ergo"
and
"nomic"
or split into "ergono"
and "mic"
.
floatbarrier
: A float barrier forces to place all floating figures and
tables before placing the remainder of the document.
You can place them manually by setting \floatbarrier
.
This option allows you to set the automatically before a heading.
Defaults to NA (only float barriers before starting a new chapter #
).
Options are "section" (before #
and ##
), "subsection" (before #
, ##
and ###
) and "subsubsection" (before #
, ##
, ###
and ####
).
other_lang
: the other languages you want to use in the pdf version.
Available options are "nl"
, "en"
and "fr"
Defaults to all available languages except the main language.
You can define some parts of the text to be in a different language than the
main language (e.g. an abstract in a different language).
This is currently limited to Dutch, English and French.
Use \bdutch
before and \edutch
after the text in Dutch.
Use \benglish
before and \eenglish
after the text in English.
Use \bfrench
before and \efrench
after the text in French.
The styles "INBO"
and "Vlaanderen"
have French and English as optional
languages.
The Flanders
style has by default Dutch and French as optional languages.
Setting the language affects the hyphenation pattern and the names of items like figures, tables, table of contents, list of figures, list of tables, references, page numbers, ...
Other output:
epub_book()
,
gitbook()
,
handouts()
,
minutes()
,
mission()
,
poster()
,
slides()
Create a poster with the INBO theme version 2015
poster( subtitle, codesize = c("footnotesize", "scriptsize", "tiny", "small", "normalsize"), lang = "english", email = "[email protected]", keep_tex = FALSE, fig_crop = TRUE, includes = NULL, pandoc_args = NULL, ... )
poster( subtitle, codesize = c("footnotesize", "scriptsize", "tiny", "small", "normalsize"), lang = "english", email = "[email protected]", keep_tex = FALSE, fig_crop = TRUE, includes = NULL, pandoc_args = NULL, ... )
subtitle |
An optional subtitle |
codesize |
relative font size for code |
lang |
The language of the document. Defaults to |
email |
The email address to display at the bottom.
Defaults to |
keep_tex |
Keep the intermediate tex file used in the conversion to PDF.
Note that this argument does not control whether to keep the auxiliary
files (e.g., ‘.aux’) generated by LaTeX when compiling ‘.tex’ to
‘.pdf’. To keep these files, you may set |
fig_crop |
|
includes |
Named list of additional content to include within the
document (typically created using the |
pandoc_args |
Additional command line options to pass to |
... |
extra parameters: see details |
Available extra parameters:
hyphenation
: the correct hyphenation for certain words
flandersfont
: Use the Flanders Art Sans font.
Defaults to FALSE
.
Note that this requires the font to be present on the system.
ORCID: a list of authors. For each author there must a name
and an
ID
.
The ID
is the author's ORCID ID , see https://orcid.org.
This information will be displayed with QR code at the bottom of the
poster.
DOI
: a list of documents.
For each document there must a name
and an ID
.
The ID
is the document's DOI, see https://doi.org.
This information will be displayed with QR code at the bottom of the
poster.
Other output:
epub_book()
,
gitbook()
,
handouts()
,
minutes()
,
mission()
,
pdf_report()
,
slides()
Insert references at this position
references(appendix = FALSE, part = FALSE)
references(appendix = FALSE, part = FALSE)
appendix |
Chapters after the references become the appendix. |
part |
Include the appendix as a part (level 0) heading. Only relevant for pdf output. |
Other utils:
add_author()
,
add_report_numbers()
,
check_dependencies()
,
column_start()
,
column_width()
,
cover_info()
,
create_report()
,
dyn_table()
,
render_natbib()
,
validate_doi()
natbib
bibliographyRender a Markdown file with natbib
bibliography
render_natbib( file, path = ".", encoding = "UTF-8", engine = c("xelatex", "pdflatex"), display = TRUE, keep = c("none", "all", "tex"), clean = TRUE )
render_natbib( file, path = ".", encoding = "UTF-8", engine = c("xelatex", "pdflatex"), display = TRUE, keep = c("none", "all", "tex"), clean = TRUE )
file |
the name of the |
path |
the path of the |
encoding |
the encoding of the |
engine |
the LaTeX engine the compile the document.
Defaults to |
display |
open the pdf in a reader. Defaults to TRUE. |
keep |
keep intermediate files after successful compilation. Defaults to "none". |
clean |
TRUE to clean intermediate files created during rendering of the
R markdown into |
Other utils:
add_author()
,
add_report_numbers()
,
check_dependencies()
,
column_start()
,
column_width()
,
cover_info()
,
create_report()
,
dyn_table()
,
references()
,
validate_doi()
Returns an output format for bookdown::render_book()
.
slides(toc = TRUE, ...)
slides(toc = TRUE, ...)
toc |
display a table of content after the title slide |
... |
currently ignored |
title
: the main title
subtitle
: the optional subtitle
author
: the authors formatted as indicated in the section below.
flandersfont
: if set to TRUE
, use the Flanders Art Sans font.
When not set, or set to FALSE
or empty, use the Calibri font.
style
: Defaults to "INBO" when missing.
"INBO"
for the INBO style.
"Vlaanderen"
for the generic style of the Flemish Government in
Dutch.
"Flanders"
for the generic style of the Flemish Government in a
language other than Dutch.
lang
: the main language of the document as RFC 5646 tags.
style
"INBO"
and "Vlaanderen"
require "nl"
as lang
.
style
"Flanders"
uses "en"
as default and can use other languages
(but not "nl"
).
"nl"
for Dutch
"en"
for English
"fr"
for French
codesize
: Relative size of R code compared to normal text.
Defaults to "footnotesize"
.
All options going from large to small are: "normalsize"
, "small"
,
"footnotesize"
, "scriptsize"
, "tiny"
.
"normalsize"
implies the same size as normal text.
Quotes are required when a part contains spaces.
If the author doesn't have an ORCID, you can omit that line.
However, note that the INBO policy is that all scientific personnel is
required to obtain an ORCID from https://orcid.org.
Add corresponding: true
to the corresponding author.
- name: given: "Authors first name" family: "Authors last name" email: "[email protected]" orcid: 0000-0002-1825-0097 corresponding: true
location
: optional text placed on the title slide below the (sub)title.
institute
: optional text placed on the title slide below the author.
toc
: add a slide with the table of content.
Defaults to TRUE
.
toc_name
: slide title for the table of content.
Defaults to Overzicht
when missing.
cover_photo
: the relative path to the image you want on the cover.
When missing, you get a default picture.
cover_horizontal
: When omitted, scale the cover_photo
so that it covers
the full page vertically.
When set to any value but FALSE
or empty, scale the cover_photo
so that
it covers the full page horizontally.
cover_offset
: A measurement like 8mm
or -1.5cm
.
Positive values move the cover_photo
upwards on the title slide.
Negative values move the cover_photo
downwards.
cover_hoffset
: Similar as cover_offset
but moves cover_photo
horizontally.
Positive values move it to the right, negative values to the left.
aspect
: the required aspect ratio for the slides.
Defaults to "16:9".
See the section below for a list of the available aspect ratios.
fontsize
: Size of the normal text on the slides.
Other elements are scaled accordingly.
Defaults to "11pt".
See the section Aspect_ratio for more details.
website
: URL in the sidebar.
Defaults to vlaanderen.be/inbo
.
The table below lists the available aspect ratios and their "paper size". The main advantage of using a small “paper size” is that you can use all your normal fonts at their natural sizes. E.g. an 11pt font on a slide is as readable as an 11pt font on a A4 paper.
aspect | ratio | width | height |
16:9 | 1.78 | 160.0 mm | 90 mm |
16:10 | 1.60 | 160.0 mm | 100 mm |
14:9 | 1.56 | 140.0 mm | 90 mm |
3:2 | 1.50 | 135.0 mm | 90 mm |
1.4:1 | 1.41 | 148.5 mm | 105 mm |
4:3 | 1.33 | 128.0 mm | 96 mm |
5:4 | 1.25 | 125.0 mm | 100 mm |
Other output:
epub_book()
,
gitbook()
,
handouts()
,
minutes()
,
mission()
,
pdf_report()
,
poster()
Checks the format of a DOI.
The format must obey https://www.doi.org/doi_handbook/2_Numbering.html#2.2
The DOI should the minimal version.
Hence no doi:
, https://doi.org
or other prefixes.
An example of a minimal version is 10.21436/inbor.70809860
.
The part before the forward slash consists of two or three sets of digits
separated by a dot.
E.g. 10.21436
or 10.21436.1
.
The part after the forward slash consists either of only digits or of
two sets of any character separated by a dot.
validate_doi(doi)
validate_doi(doi)
doi |
a string containing the DOI. |
Other utils:
add_author()
,
add_report_numbers()
,
check_dependencies()
,
column_start()
,
column_width()
,
cover_info()
,
create_report()
,
dyn_table()
,
references()
,
render_natbib()