instructions_specify: Specify instructions!

Description Usage Arguments Note Author(s) See Also

Description

This function is not meant to be called directly by the user. It is integrated into the function 'instructions_execute' for batch processing of input_files.

Usage

1
2
3
instructions_specify(input_files, image_cache, instruction, filename_noxt,
  basename_noxt, figure_source, toplvl, rebuild_figures, quiet_processing,
  Rplots_device)

Arguments

input_files

Character. File path relative to the current working directory. Possible file extensions: Rmd, R and Rnw.

image_cache

Character. File path to write an image.

instruction

Character. Possible values: 'nothing', 'load', 'source', 'render' and 'knit'.

filename_noxt

Character. Complete file path without extension.

basename_noxt

Character. Basename of the file without extension.

figure_source

Character. File path to write figures.

toplvl

Character. Passed to knit_root_dir.

rebuild_figures

Logical. Delete figure_source before processing?

quiet_processing

Logical. Passed to !echo (if instruction == source) or quiet (if instruction == render or knit).

Rplots_device

Function. Specify function that will be passed to a functional to write figures of R-files (if instruction == source). E.g. grDevices::pdf or grDevices::png.

Note

This function is part of a family of functions each of which begin with 'instructions_'. The order to call these functions is: 'instructions_prepare', 'instructions_implement', 'instructions_check', 'instructions_execute', 'instructions_symlink' and 'instructions_supplement'.

Author(s)

Frederik Sachser

See Also

instructions_prepare, instructions_implement, instructions_check, instructions_execute, instructions_symlink, instructions_supplement


sachserf/framework documentation built on May 29, 2019, 12:21 p.m.