Package 'INBOmd'

Description

This function will interactively add the information of an author from the local authors database.

Usage

add_author(path = ".")

Arguments

See Also

Other utils: add_report_numbers(), check_dependencies(), column_start(), column_width(), cover_info(), create_report(), dyn_table(), references(), render_natbib(), validate_doi()

Description

Add the report numbers to a bookdown report

Usage

add_report_numbers(
  path = ".",
  doi,
  year,
  reportnr,
  depotnr,
  photo,
  description,
  embargo = Sys.Date(),
  ordernr,
  copies,
  motivation,
  pages
)

Arguments

See Also

Other utils: add_author(), check_dependencies(), column_start(), column_width(), cover_info(), create_report(), dyn_table(), references(), render_natbib(), validate_doi()

Description

Check if the required dependencies of INBOmd are installed Missing dependencies will be installed automatically

Usage

check_dependencies()

See Also

Other utils: add_author(), add_report_numbers(), column_start(), column_width(), cover_info(), create_report(), dyn_table(), references(), render_natbib(), validate_doi()

Description

Calculate the starting position of an A0 column

Usage

column_start(number = 3, start = 1, margin = 20, edge = 10)

Arguments

See Also

Other utils: add_author(), add_report_numbers(), check_dependencies(), column_width(), cover_info(), create_report(), dyn_table(), references(), render_natbib(), validate_doi()

Description

Calculate the width of an A0 column

Usage

column_width(number = 3, margin = 20, edge = 10)

Arguments

See Also

Other utils: add_author(), add_report_numbers(), check_dependencies(), column_start(), cover_info(), create_report(), dyn_table(), references(), render_natbib(), validate_doi()

Description

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.

Usage

cover_info(path = "index.Rmd")

Arguments

See Also

Other utils: add_author(), add_report_numbers(), check_dependencies(), column_start(), column_width(), create_report(), dyn_table(), references(), render_natbib(), validate_doi()

Description

Create a template for an INBOmd bookdown report

Usage

create_report(path = ".", shortname)

Arguments

See Also

Other utils: add_author(), add_report_numbers(), check_dependencies(), column_start(), column_width(), cover_info(), dyn_table(), references(), render_natbib(), validate_doi()

Description

• interactive session: DT::datatable()

• html: DT::datatable()

• other: knitr::kable()

Usage

dyn_table(x, caption = NULL, rownames = FALSE, escape = TRUE, align, ...)

Arguments

See Also

Other utils: add_author(), add_report_numbers(), check_dependencies(), column_start(), column_width(), cover_info(), create_report(), references(), render_natbib(), validate_doi()

Description

A version of bookdown::epub_book() with a different styling.

Usage

epub_book()

Available YAML headers options shared among output formats

• 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.

Formatting author information

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

Available YAML headers options specific for reports

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.

See Also

Other output: gitbook(), handouts(), minutes(), mission(), pdf_report(), poster(), slides()

Description

A version of bookdown::gitbook() with a different styling.

Usage

gitbook(code_folding = c("none", "show", "hide"))

Arguments

Available YAML headers options shared among output formats

• 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.

Formatting author information

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

Available YAML headers options specific for reports

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.

Available YAML headers options specific for 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.

See Also

Other output: epub_book(), handouts(), minutes(), mission(), pdf_report(), poster(), slides()

Description

Similar to slides() except that you can't have progressive slides. And you can place multiple slides on a single page.

Usage

handouts(
  toc = TRUE,
  nup = c("8", "1", "1plus", "2", "3", "3plus", "4", "4plus", "6"),
  ...
)

Arguments

Available YAML headers options shared among output formats

• 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.

Formatting author information

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

Available YAML headers options specific for slides

• 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.

Aspect ratio

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.

See Also

Other output: epub_book(), gitbook(), minutes(), mission(), pdf_report(), poster(), slides()

Description

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".

Usage

insert_block()

insert_exampleblock()

insert_alertblock()

Description

Usage

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, ...)

Arguments

Description

Create a minutes of a meeting with the INBO corporate identity

Usage

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,
  ...
)

Arguments

Details

Available extra parameters:

• hyphenation: the correct hyphenation for certain words

See Also

Other output: epub_book(), gitbook(), handouts(), mission(), pdf_report(), poster(), slides()

Description

Create a mission report with the INBO corporate identity

Usage

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,
  ...
)

Arguments

Details

Available extra parameters:

• hyphenation: the correct hyphenation for certain words

See Also

Other output: epub_book(), gitbook(), handouts(), minutes(), pdf_report(), poster(), slides()

Description

Create a report with the Flemish corporate identity

Usage

pdf_report(fig_crop = "auto", includes = NULL, pandoc_args = NULL, ...)

Arguments

Available YAML headers options shared among output formats

• 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.

Formatting author information

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

Available YAML headers options specific for reports

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.

Available YAML headers options specific for reports in pdf format

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.

Multiple languages in pdf

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, ...

See Also

Other output: epub_book(), gitbook(), handouts(), minutes(), mission(), poster(), slides()

Description

Create a poster with the INBO theme version 2015

Usage

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,
  ...
)

Arguments

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.

See Also

Other output: epub_book(), gitbook(), handouts(), minutes(), mission(), pdf_report(), slides()

Description

Insert references at this position

Usage

references(appendix = FALSE, part = FALSE)

Arguments

See Also

Other utils: add_author(), add_report_numbers(), check_dependencies(), column_start(), column_width(), cover_info(), create_report(), dyn_table(), render_natbib(), validate_doi()

Description

Render a Markdown file with natbib bibliography

Usage

render_natbib(
  file,
  path = ".",
  encoding = "UTF-8",
  engine = c("xelatex", "pdflatex"),
  display = TRUE,
  keep = c("none", "all", "tex"),
  clean = TRUE
)

Arguments

See Also

Other utils: add_author(), add_report_numbers(), check_dependencies(), column_start(), column_width(), cover_info(), create_report(), dyn_table(), references(), validate_doi()

Description

Returns an output format for bookdown::render_book().

Usage

slides(toc = TRUE, ...)

Arguments

Available YAML headers options shared among output formats

• 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.

Formatting author information

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

Available YAML headers options specific for slides

• 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.

Aspect ratio

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.

See Also

Other output: epub_book(), gitbook(), handouts(), minutes(), mission(), pdf_report(), poster()

Description

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.

Usage

validate_doi(doi)

Arguments

See Also

Other utils: add_author(), add_report_numbers(), check_dependencies(), column_start(), column_width(), cover_info(), create_report(), dyn_table(), references(), render_natbib()