Skip to contents

Wrapper for read_yaml() to make this function available to modules dependent on formods.

Usage

FM_read_yaml(file)

Arguments

file

yaml file.

Value

List containing the contents of the yaml file.

Examples

res = FM_read_yaml(
   system.file(package = "formods",
                         "templates",
                         "formods.yaml"))

res
#> $FM
#> $FM$include
#> $FM$include$files
#> $FM$include$files[[1]]
#> $FM$include$files[[1]]$file
#> $FM$include$files[[1]]$file$source
#> [1] "file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\")"
#> 
#> $FM$include$files[[1]]$file$dest
#> [1] "file.path(\"config\",\"report.docx\")"
#> 
#> 
#> 
#> $FM$include$files[[2]]
#> $FM$include$files[[2]]$file
#> $FM$include$files[[2]]$file$source
#> [1] "file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\")"
#> 
#> $FM$include$files[[2]]$file$dest
#> [1] "file.path(\"config\",\"report.pptx\")"
#> 
#> 
#> 
#> $FM$include$files[[3]]
#> $FM$include$files[[3]]$file
#> $FM$include$files[[3]]$file$source
#> [1] "file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\")"
#> 
#> $FM$include$files[[3]]$file$dest
#> [1] "file.path(\"config\",\"report.yaml\")"
#> 
#> 
#> 
#> 
#> 
#> $FM$deployed
#> [1] FALSE
#> 
#> $FM$code
#> $FM$code$theme
#> [1] "vibrant_ink"
#> 
#> $FM$code$showLineNumbers
#> [1] TRUE
#> 
#> $FM$code$gen_file
#> [1] "run_analysis.R"
#> 
#> $FM$code$gen_preamble
#> [1] "# formods automated output ------------------------------------------------\n# https://formods.ubiquity.tools/\nrm(list=ls())"
#> 
#> $FM$code$packages
#> [1] "onbrand" "rio"    
#> 
#> 
#> $FM$notifications
#> $FM$notifications$config
#> $FM$notifications$config$success
#> $FM$notifications$config$success$useFontAwesome
#> [1] FALSE
#> 
#> $FM$notifications$config$success$useIcon
#> [1] FALSE
#> 
#> $FM$notifications$config$success$background
#> [1] "#5bb85b"
#> 
#> 
#> $FM$notifications$config$failure
#> $FM$notifications$config$failure$useFontAwesome
#> [1] FALSE
#> 
#> $FM$notifications$config$failure$useIcon
#> [1] FALSE
#> 
#> $FM$notifications$config$failure$background
#> [1] "#d9534f"
#> 
#> 
#> $FM$notifications$config$info
#> $FM$notifications$config$info$useFontAwesome
#> [1] FALSE
#> 
#> $FM$notifications$config$info$useIcon
#> [1] FALSE
#> 
#> $FM$notifications$config$info$background
#> [1] "#5bc0de"
#> 
#> 
#> $FM$notifications$config$warning
#> $FM$notifications$config$warning$useFontAwesome
#> [1] FALSE
#> 
#> $FM$notifications$config$warning$useIcon
#> [1] FALSE
#> 
#> $FM$notifications$config$warning$background
#> [1] "#f0ac4d"
#> 
#> 
#> 
#> 
#> $FM$reporting
#> $FM$reporting$enabled
#> [1] TRUE
#> 
#> $FM$reporting$content_init
#> $FM$reporting$content_init$xlsx
#> [1] "rpt = list(summary = NULL,\n           sheets  = list())"
#> 
#> $FM$reporting$content_init$docx
#> [1] "rpt  = onbrand::read_template(\n  template = file.path(\"config\", \"report.docx\"),\n  mapping  = file.path(\"config\", \"report.yaml\"))"
#> 
#> $FM$reporting$content_init$pptx
#> [1] "rpt  = onbrand::read_template(\n  template = file.path(\"config\", \"report.pptx\"),\n  mapping  = file.path(\"config\", \"report.yaml\"))"
#> 
#> 
#> $FM$reporting$phs
#> $FM$reporting$phs[[1]]
#> $FM$reporting$phs[[1]]$name
#> [1] "HEADERLEFT"
#> 
#> $FM$reporting$phs[[1]]$location
#> [1] "header"
#> 
#> $FM$reporting$phs[[1]]$value
#> [1] ""
#> 
#> $FM$reporting$phs[[1]]$tooltip
#> [1] "left header text"
#> 
#> 
#> $FM$reporting$phs[[2]]
#> $FM$reporting$phs[[2]]$name
#> [1] "HEADERRIGHT"
#> 
#> $FM$reporting$phs[[2]]$location
#> [1] "header"
#> 
#> $FM$reporting$phs[[2]]$value
#> [1] ""
#> 
#> $FM$reporting$phs[[2]]$tooltip
#> [1] "right header text"
#> 
#> 
#> $FM$reporting$phs[[3]]
#> $FM$reporting$phs[[3]]$name
#> [1] "FOOTERLEFT"
#> 
#> $FM$reporting$phs[[3]]$location
#> [1] "footer"
#> 
#> $FM$reporting$phs[[3]]$value
#> [1] ""
#> 
#> $FM$reporting$phs[[3]]$tooltip
#> [1] "left footer text"
#> 
#> 
#> 
#> $FM$reporting$phs_formatting
#> $FM$reporting$phs_formatting$width
#> [1] "100%"
#> 
#> $FM$reporting$phs_formatting$tt_position
#> [1] "left"
#> 
#> $FM$reporting$phs_formatting$tt_size
#> [1] "medium"
#> 
#> 
#> 
#> $FM$ui
#> $FM$ui$button_style
#> [1] "fill"
#> 
#> $FM$ui$select_size
#> [1] 10
#> 
#> $FM$ui$color_green
#> [1] "#00BB8A"
#> 
#> $FM$ui$color_red
#> [1] "#FF475E"
#> 
#> $FM$ui$color_blue
#> [1] "#0088FF"
#> 
#> $FM$ui$color_purple
#> [1] "#bd2cf4"
#> 
#> $FM$ui$color_orange
#> [1] "#FEC108"
#> 
#> $FM$ui$color_yellow
#> [1] "#FFE447"
#> 
#> 
#> $FM$data_meta
#> $FM$data_meta$data_header
#> [1] "<span style='color:===COLOR==='><b>===NAME===</b><br/><font size='-3'>===LABEL===</font></span>"
#> 
#> $FM$data_meta$subtext
#> [1] "===LABEL===: ===RANGE==="
#> 
#> $FM$data_meta$many_sep
#> [1] ",...,"
#> 
#> $FM$data_meta$data_types
#> $FM$data_meta$data_types$character
#> $FM$data_meta$data_types$character$color
#> [1] "#DD4B39"
#> 
#> $FM$data_meta$data_types$character$label
#> [1] "text"
#> 
#> 
#> $FM$data_meta$data_types$double
#> $FM$data_meta$data_types$double$color
#> [1] "#3C8DBC"
#> 
#> $FM$data_meta$data_types$double$label
#> [1] "num"
#> 
#> 
#> $FM$data_meta$data_types$integer
#> $FM$data_meta$data_types$integer$color
#> [1] "#3C8DBC"
#> 
#> $FM$data_meta$data_types$integer$label
#> [1] "num"
#> 
#> 
#> $FM$data_meta$data_types$other
#> $FM$data_meta$data_types$other$color
#> [1] "black"
#> 
#> $FM$data_meta$data_types$other$label
#> [1] "other"
#> 
#> 
#> 
#> 
#> $FM$workflows
#> $FM$workflows$example
#> $FM$workflows$example$group
#> [1] "Examples"
#> 
#> $FM$workflows$example$desc
#> [1] "Example Workflow"
#> 
#> $FM$workflows$example$require_ds
#> [1] TRUE
#> 
#> $FM$workflows$example$preload
#> [1] "file.path('.', 'example.yaml')"
#> 
#> 
#> 
#> $FM$labels
#> $FM$labels$ui_label
#> [1] "put labels here"
#> 
#> 
#> $FM$user_files
#> $FM$user_files$use_tmpdir
#> [1] TRUE
#> 
#> 
#> $FM$logging
#> $FM$logging$enabled
#> [1] TRUE
#> 
#> $FM$logging$timestamp
#> [1] TRUE
#> 
#> $FM$logging$timestamp_fmt
#> [1] "%Y-%m-%d %H:%M:%S"
#> 
#> $FM$logging$log_file
#> [1] "formods_log.txt"
#> 
#> $FM$logging$console
#> [1] TRUE
#> 
#> 
#>