yamlDump: Outputs an object

View source: R/yamlDump.R

yamlDumpR Documentation

Outputs an object

Description

Manually viewing a list object can be tricky where the natural print can be hard to work through. The config format *yaml* is increadibly dense and useful not only for writing configs but also viewing them which 'yamlDump' helps with.

Usage

yamlDump(x)

Arguments

x

An object that as.yaml accepts

Value

void

Examples

some_fancy_list <- list(complex = list(some_data = 1:3,
                                       other_data = list(name = "Max")),
                        simple = "awesome overview")
yamlDump(some_fancy_list)
#complex:
#  some_data:
#  - 1
#  - 2
#  - 3
#  other_data:
#    name: Max
#simple: awesome overview

# If you got a character json you can also input it directly
# and the function will automatically convert it to a list
yamlDump('{"a":{"b":["1"]}}')


Gmisc documentation built on Aug. 26, 2023, 1:07 a.m.