RInno (version 0.1.2)

directives: Inno Setup Preprocessor (ISPP) Directives

Description

Sets ISPP directives at the top of an ISS.

Usage

directives(app_name, include_R = FALSE, R_version = paste0(R.version$major,
  ".", R.version$minor), include_Pandoc = FALSE,
  Pandoc_version = rmarkdown::pandoc_version(), include_Chrome = FALSE,
  app_version = "0.0.0", publisher = "", main_url = "",
  custom_vars = "", custom_values = "")

Arguments

app_name

The name of the app being installed. It will be displayed throughout the installer's window titles, wizard pages, and dialog boxes. See [Setup]:AppName for details. For continuous installations, app_name is used to check for an R package of the same name, and update it. The Continuous Installation vignette has more details.

include_R

To include R in the installer, include_R = TRUE. This will include the version of R specified by R_version in your installer. The installer will check each user's registry for that version of R, and only install it if necessary.

R_version

R version to use, defaults to: paste0(R.version$major, '.', R.version$minor).

include_Pandoc

To include Pandoc in the installer, include_Pandoc = TRUE. If installing a flexdashboard app, some users may need a copy of Pandoc. Similar to including R, the installer will check the user's registry for the version of Pandoc returned by pandoc_version and only install it if necessary.

Pandoc_version

Pandoc version to use, defaults to: pandoc_version.

include_Chrome

To include Chrome in the installer, include_Chrome = TRUE. If you would like to use Chrome's app mode, this option includes a copy of Chrome for users that do not have it installed yet.

app_version

Version number of the app being installed, defaults to '0.0.0'. It is displayed in the Version field of the app's Add/Remove Programs entry. See [Setup]:AppVersion for details.

publisher

String displayed on the "Support" dialogue of the Add/Remove Programs Control Panel applet, defaults to " ". See [Setup]:AppPublisher for details.

main_url

String. Defaults to "".

custom_vars

String vector. Defaults to "", and must be the same length as custom_values.

custom_values

String vector of values for custom_vars. Defaults to "", and must be the same length as custom_vars.

Value

Chainable character vector, which can be used as the text argument of writeLines to generate an ISS.

Details

ISPP directives automate compile-time tasks and decrease the probability of typos. When referring to an ISPP directive, use '{#var_name}'. For more information, call ispp_doc() or visit ISPP Help.

custom_vars and custom_values utilize the #define directive.

See Also

get_R, copy_installation, create_config, create_bat, directives, setup, languages, tasks, files, icons, run, and code.

Examples

# NOT RUN {
start_iss('myapp') %>%
  directives(include_R = FALSE, R_version = '3.3.2',
    custom_vars = 'helpers', custom_values = 'path\\to\\helpers') %>%
  files(app_dir = getwd(),
    file_list = '{#helpers}')
# }
# NOT RUN {
# }