bookdown_zenodo: Render a 'bookdown' and upload to Zenodo

In inbo/checklist: A Thorough and Strict Set of Checks for R Packages and Source Code

Render a bookdown and upload to Zenodo

Description

First clears all the existing files in the output_dir set in ⁠_bookdown_.yml⁠. Then renders all required output formats and uploads them to Zenodo. bookdown_zenodo() creates a draft record when you don't specify a community in the yaml. Otherwise it creates a review request for the first community.

Usage

bookdown_zenodo(
  path,
  zip_format = c("bookdown::gitbook", "INBOmd::gitbook"),
  single_format = c("bookdown::pdf_book", "bookdown::epub_book", "INBOmd::pdf_report",
    "INBOmd::epub_book"),
  token,
  sandbox = TRUE,
  logger = "INFO"
)

Arguments

path	The root folder of the report
zip_format	A vector with output formats that generate multiple files. The function will bundle all the files in a zip file for every format.
single_format	A vector with output formats that generate a single output file. The output will remain as is.
token	the user token for Zenodo. By default an attempt will be made to retrieve token using zenodo_pat().
sandbox	When TRUE, upload a test version to https://sandbox.zenodo.org. When FALSE, upload the final version to https://zenodo.org.
logger	Type of logger for Zenodo upload. Defaults to "INFO" which provides minimal logs. Use NULL to hide the logs. "DEBUG" provides the full log.

See Also

Other utils: ask_yes_no(), author2df(), c_sort(), create_hexsticker(), execshell(), menu_first(), orcid2person(), store_authors(), use_author(), validate_email(), validate_orcid(), yesno()

inbo/checklist documentation built on June 15, 2025, 12:54 p.m.