TBox: Useful Functions for Programming and Generating Documents

Description

Tools to help developers and producers manipulate R objects and outputs. It includes tools for displaying results and objects, and for formatting them in the correct format.

Author(s)

Maintainer: Tanguy Barthelemy tanguy.barthelemy@insee.fr

See Also

Useful links:

• https://github.com/TanguyBarthelemy/TBox

• https://tanguybarthelemy.github.io/TBox/

• Report bugs at https://github.com/TanguyBarthelemy/TBox/issues

Create preamble .tex for code font

Description

Create preamble .tex for code font

Usage

create_preamble_tex(font_size = 12, monofont_path = get_fira_path())

Arguments

Value

a vector of characters representing an Rmd file (each element being a line)

Examples

create_preamble_tex()
create_preamble_tex(font_size = 18.0)

Generate R chunk header

Description

Function to generate R chunk header for rmarkdown rendering in different output

Usage

generate_chunk_header(...)

Arguments

Details

To get the list of all accepted options, you can call names(knitr::opts_chunk$get()) and to get the default values you can call knitr::opts_chunk$get().

More information in the function #' opts_chunk or directly https://yihui.org/knitr/options/#chunk-options to see all available options and their descriptions.

Value

a string of length 1

Examples

generate_chunk_header()
generate_chunk_header(eval = TRUE, echo = TRUE)
generate_chunk_header(results = "asis")
generate_chunk_header(fig.width = "4px", fig.height = "3px")

Generate Rmd file

Description

This function creates the Rmd file which will be rendered in a specific format.

Usage

generate_rmd_file(
  content,
  output_format = c("word", "pdf", "html", "word_document", "pdf_document",
    "html_document"),
  code = TRUE,
  ...
)

Arguments

Details

More information about the argument ... in the documentation of the function render_code.

Value

a vector of characters representing an Rmd file (each element being a line)

Examples

generate_rmd_file(content = "Bonjour tout le monde",
                  code = FALSE,
                  output_format = "word")
generate_rmd_file(content = "print(AirPassengers)",
                  code = TRUE,
                  output_format = "pdf",
                  eval = TRUE,
                  echo = FALSE)
generate_rmd_file(content = "plot(AirPassengers)",
                  code = TRUE,
                  output_format = "html_document",
                  eval = FALSE,
                  echo = TRUE)

Lecture des fichiers de donnée

Description

Fonction de lecture de fichiers csv

Usage

get_data(path, erase_zero = TRUE, sep = ";", dec = ".", ...)

Arguments

Details

par defaul

Value

Un objet de type data.frame.

Examples

file_path <- system.file("extdata", "file.csv", package = "TBox")
file_path <- normalizePath(file_path, winslash = "/", mustWork = FALSE)

df <- get_data(file_path, erase_zero = FALSE)

The path to the font Fira Code

Description

This function returns the path to the font Fira Code installed with the package TBox.

Usage

get_fira_path()

Details

This function helps the other functions to find the path to the font Fira Code to render documents and use this font by default for code chunks.

Value

a character vector of length 1 representing the path

Examples

get_fira_path()

The latex engine

Description

This function returns the latex engine available to render .tex file into pdf.

Usage

get_latex_engine()

Details

If several latex engine are available, the choice will be done in this order:

• xelatex;

• lualatex;

• pdflatex;

• tectonic.

Value

a character vector of length 1 representing the latex engine.

Examples

get_latex_engine()

The path to the word template

Description

This function returns the path to the word template installed with the package TBox.

Usage

get_word_template_path()

Details

This function helps the other functions to find the template of the word document used to render in .docx output.

Value

a character vector of length 1 representing the path

Examples

get_word_template_path()

Generate a file with formatted code

Description

Format a piece of code to copy it into an email, a pdf, a document, etc.

Usage

render_code(
  output_format = c("word", "pdf", "html", "word_document", "pdf_document",
    "html_document"),
  browser = getOption("browser"),
  font_size = 12,
  code = TRUE,
  open = TRUE,
  monofont_path = get_fira_path(),
  word_template_path = get_word_template_path(),
  ...
)

Arguments

Details

This function allows the user to generate formatted code (for email, document, copy, message, etc.) on the fly.

It accepts mainly word, pdf and html formats, but any format accepted by rmarkdown on the computer.

To use this function, simply copy a piece of code and run render_code() with the arguments that interest us. If you want content that is not R code, use the code argument to FALSE. In pdf format, you can change the font size using the font_size argument. Also, you can change the browser that opens the file by default with the browser argument.

With the argument ..., you can specify knitr arguments to be included in the chunk. For example, you can add eval = TRUE (if you want the R code to be evaluated (and the result displayed)), echo = FALSE (if you don't want to display the code)...

More information in the function opts_chunk or directly https://yihui.org/knitr/options/#chunk-options to see all available options and their descriptions.

If the open argument is set to FALSE then the browser argument will be ignored.

Value

This function returns invisibly (with invisible()) a vector of length two with two element:

• the path of the created rmarkdown (template) document (.Rmd);

• the path of the created output (in the format .pdf, .docx or .html).

Examples

# Copy a snippet of code
if (clipr::clipr_available()) {
    clipr::write_clip("plot(AirPassengers)", allow_non_interactive = TRUE)
}

render_code(
    output_format = "word",
    echo = TRUE
)

render_code(
    output_format = "html",
    eval = FALSE
)


render_code(
    output = "pdf",
    eval = TRUE,
    font_size = 16
)

Ecriture des fichiers de donnée

Description

Ecriture des fichiers de donnée

Usage

write_data(data, path)

Arguments

Details

La fonction écrit les données dans un fichier csv avec les paramètres suivants : - séparateur de colonne : ; - séparateur décimal : . - pas de guillemets - pas de noms de lignes - les NA sont remplacés par une chaîne vide.

Value

Chaîne de caractère. Chemin du fichier écrit.

Examples

new_path <- tempfile("new_file", fileext = ".csv")
write_data(data = mtcars, path = new_path)