Skip to contents

Writes an object's metadata .json file

Usage

write_object_metadata(
  object_file,
  meta_type = NULL,
  equations = NULL,
  notes = NULL,
  abbrevs = NULL,
  table1_format = F
)

Arguments

object_file

Path to the file of the object to write metadata for

meta_type

A string denoting what standard notes to use

equations

Additional equations to include in metadata, either string of single equation or vector of multiple

notes

Additional notes to include in metadata, either string of single note or vector of multiple

abbrevs

Additional abbreviations to include in metadata, either string of single abbrev or vector of multiple

table1_format

Boolean for using table1 formatting for flextables

Examples

if (FALSE) { # \dontrun{
ft <- flextable(iris)

write_object_metadata(ft, "table", file_path)
} # }