% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/lexical_analysis.R
\name{calculate_text_readability}
\alias{calculate_text_readability}
\title{Calculate Text Readability}
\usage{
calculate_text_readability(
  texts,
  metrics = c("flesch", "flesch_kincaid", "gunning_fog"),
  include_lexical_diversity = TRUE,
  include_sentence_stats = TRUE,
  doc_names = NULL
)
}
\arguments{
\item{texts}{Character vector of texts to analyze}

\item{metrics}{Character vector of readability metrics to calculate.
Options: "flesch", "flesch_kincaid", "gunning_fog", "smog", "ari", "coleman_liau"}

\item{include_lexical_diversity}{Logical, include the MTLD lexical diversity
index (default: TRUE)}

\item{include_sentence_stats}{Logical, include average sentence length (default: TRUE)}

\item{doc_names}{Optional character vector of document names}
}
\value{
A data frame with document names and readability scores
}
\description{
Calculates multiple readability metrics for texts including Flesch Reading Ease,
Flesch-Kincaid Grade Level, Gunning FOG index, and others. Optionally includes
lexical diversity metrics and sentence statistics.
}
\examples{
\donttest{
data(SpecialEduTech, package = "TextAnalysisR")
texts <- SpecialEduTech$abstract[1:10]
readability <- calculate_text_readability(texts)
print(readability)
}

}
\concept{lexical}
