% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/dictate_dictionary.R
\name{dictate_dictionary}
\alias{dictate_dictionary}
\title{Interactive Data Dictionary Dictator}
\usage{
dictate_dictionary()
}
\value{
Invisibly returns a named list with components: \code{status} ("done",
"cancelled", or "error"), \code{dataset}, \code{dimensions},
\code{output}, and \code{roxygen_block} (character vector).
}
\description{
Generates roxygen2 documentation for a data frame by interactively prompting 
the user for a dataset title, a general description, and individual column 
descriptions.
}
\details{
The function performs the following steps:
\enumerate{
  \item Scans the global environment for all available data frames.
  \item Prompts the user to select a target data frame for documentation.
  \item Collects high-level metadata (title and description) for the dataset.
  \item Iterates through each column, displaying its type and prompting the 
      user for a descriptive label.
  \item Assembles the collected information into a CRAN-compliant roxygen2 
      block using the `\\describe{}` tag.
  \item Offers the user the choice to either print the resulting block to 
      the console or append it to `R/data.R`.
}
}
\section{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()
}
}
