generate_yaml_from_directory: Generate YAML File from Directory Structure

In saros.base: Base Tools for Semi-Automatic Reporting of Ordinary Surveys

Generate YAML File from Directory Structure

Description

Generate YAML File from Directory Structure

Usage

generate_yaml_from_directory(
  input_path = tempdir(),
  output_yaml_path = "_project_structure_en.yaml",
  remove_prefix_numbers = FALSE
)

Arguments

input_path	String. The path to the directory whose structure needs to be captured.
output_yaml_path	String. The path where the YAML file will be saved.
remove_prefix_numbers	Boolean. Whether to remove numeric prefixes and any resulting leading non-alphanumeric characters from folder names. Defaults to FALSE.

Value

No return value, called for side effects

Examples

generate_yaml_from_directory(
  output_yaml_path =
    tempfile("_project_structure_en", fileext = ".yaml")
)

saros.base documentation built on June 8, 2025, 10:03 a.m.