Generates roxygen2 documentation for a data frame by interactively prompting the user for a dataset title, a general description, and individual column descriptions.
Value
Invisibly returns a named list with components: status ("done",
"cancelled", or "error"), dataset, dimensions,
output, and roxygen_block (character vector).
Details
The function performs the following steps:
Scans the global environment for all available data frames.
Prompts the user to select a target data frame for documentation.
Collects high-level metadata (title and description) for the dataset.
Iterates through each column, displaying its type and prompting the user for a descriptive label.
Assembles the collected information into a CRAN-compliant roxygen2 block using the `\describe` tag.
Offers the user the choice to either print the resulting block to the console or append it to `R/data.R`.
Warning
This function modifies files on disk or the global environment. Please ensure you have a backup or are using version control (e.g., Git) before execution.
Examples
if (interactive()) {
dictate_dictionary()
}