Package 'df2yaml'

Title: Convert Dataframe to 'YAML'
Description: The 'df2yaml' aims to simplify the process of converting 'dataframe' to 'YAML' <https://yaml.org/>. The 'dataframe' with multiple key columns and one value column will be converted to the multi-level hierarchy.
Authors: Yabing Song [aut, cre]
Maintainer: Yabing Song <[email protected]>
License: MIT + file LICENSE
Version: 0.3.1
Built: 2024-11-11 03:28:38 UTC
Source: https://github.com/showteeth/df2yaml

Help Index


Convert dataframe to YAML.

Description

Convert dataframe to YAML.

Usage

df2yaml(
  df,
  key_col,
  val_col,
  val_sep = ";",
  key_sep = ":",
  rm_quote = TRUE,
  out_yaml = NULL
)

Arguments

df

Dataframe.

key_col

The columns used as keys.

val_col

The columns used as values, this column can contain key: value pairs.

val_sep

The separator used to seperate different key:value pairs in val_col. Default: ";".

key_sep

The separator used to seperate key and value. Default: ":".

rm_quote

Logical value, whether to remove single quotes. Default: TRUE.

out_yaml

Output YAML file. Default: NULL (return string).

Value

NULL (write YAML) or string (if out_yaml is NULL).

Examples

library(df2yaml)
test_file <- system.file("extdata", "df2yaml_l3.txt", package = "df2yaml")
test_data <- read.table(file = test_file, header = TRUE, sep = "\t")
df2yaml(df = test_data, key_col = c("paras", "subcmd"), val_col = "values")

Convert dataframe to YAML.

Description

Convert dataframe to YAML.

Usage

df2yaml2(
  df,
  key_col = c("paras", "subcmd"),
  val_col = "values",
  val_sep = ";",
  key_sep = ":",
  out_yaml = NULL
)

Arguments

df

Dataframe.

key_col

The columns used as keys, up to 2.

val_col

The columns used as values, this column can contain key: value pairs.

val_sep

The separator used to seperate different key:value pairs in val_col. Default: ";".

key_sep

The separator used to seperate key and value. Default: ":".

out_yaml

The output yaml file. Default: NULL (string).

Value

NULL (write YAML) or string (if out_yaml is NULL).

Examples

library(df2yaml)
test_file <- system.file("extdata", "df2yaml_l3.txt", package = "df2yaml")
test_data <- read.table(file = test_file, header = TRUE, sep = "\t")
df2yaml(df = test_data, key_col = c("paras", "subcmd"), val_col = "values")