write_labels_to_xl: Write labels to an Excel file

Description Usage Arguments Details Value

View source: R/write_labels_to_xl.R

Description

These function writes labels to an Excel file (by first converting them to a data frame).

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
write_labels_to_xl(
  x,
  file,
  idCol,
  labelCol,
  preventOverwriting = mdmcda::opts$get("preventOverwriting"),
  quiet = mdmcda::opts$get("quiet")
)

write_criterionLabels_to_xl(
  x,
  file,
  preventOverwriting = mdmcda::opts$get("preventOverwriting"),
  quiet = mdmcda::opts$get("quiet")
)

write_decisionLabels_to_xl(
  x,
  file,
  preventOverwriting = mdmcda::opts$get("preventOverwriting"),
  quiet = mdmcda::opts$get("quiet")
)

write_scenarioLabels_to_xl(
  x,
  file,
  preventOverwriting = mdmcda::opts$get("preventOverwriting"),
  quiet = mdmcda::opts$get("quiet")
)

write_alternativeLabels_to_xl(
  x,
  file,
  preventOverwriting = mdmcda::opts$get("preventOverwriting"),
  quiet = mdmcda::opts$get("quiet")
)

Arguments

x

The object with the labels: a named vector, except for alternative labels, which is a nested named list (see [read_labels_from_xl()]).

file

The filename to write to.

idCol, labelCol

For 'write_labels_to_xl()', the name of the columns with the identifiers and the labels.

Details

The 'write_labels_to_xl()' function is the underlying function; users typically don't interact with this function, unless they specified custom column names.

Value

The written data frame.


Matherion/mdmcda documentation built on Dec. 31, 2020, 3:13 p.m.