create_data_description.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/use_document_data.R
\name{create_data_description}
\alias{create_data_description}
\title{Create Data Description}
\usage{
create_data_description(dataset, name, description, source)
}
\arguments{
\item{dataset}{A data frame for which the description is to be generated.}

\item{name}{The name of the data set, which will be used in the title and usage
sections of the generated description.}

\item{description}{A character string for the data set description.}

\item{source}{A character string indicating the source of the data set.}
}
\value{
A character string containing the structured documentation template
for the data set. This includes the data set's basic information and
placeholders for detailed descriptions of each variable.
}
\description{
Generates a description of a data set, including information about
its type, class, dimensions (rows and columns), and a placeholder for each
variable's description. This description is formatted as a string that could
be used directly in R documentation files or other descriptive materials.
}
\keyword{internal}