# A Text Mining Workflow Tool

## Documentation for package ‘TextAnalysisR’ version 0.1.4

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

A C D E F G I L P R S U V W

## -- A --

acronym | Acronym List
analyze_document_clustering | Analyze Document Clustering
analyze_semantic_evolution | Analyze Semantic Evolution
analyze_sentiment | Analyze Text Sentiment
analyze_sentiment_llm | LLM-based Sentiment Analysis
analyze_similarity_gaps | Analyze Similarity Gaps Between Categories
assess_embedding_stability | Assess Embedding Topic Model Stability
auto_tune_embedding_topics | Auto-tune BERTopic Hyperparameters

## -- C --

calculate_assignment_consistency | Calculate Assignment Consistency
calculate_clustering_metrics | Calculate Clustering Quality Metrics
calculate_cross_similarity | Calculate Cross-Matrix Cosine Similarity
calculate_dispersion_metrics | Calculate Dispersion Metrics
calculate_keyword_stability | Calculate Keyword Stability
calculate_lexical_dispersion | Calculate Lexical Dispersion
calculate_log_odds_ratio | Calculate Log Odds Ratio Between Categories
calculate_semantic_drift | Calculate Semantic Drift
calculate_similarity_robust | Calculate Document Similarity with Fallbacks
calculate_text_readability | Calculate Text Readability
calculate_topic_probability | Calculate Topic Probabilities
calculate_topic_stability | Calculate Topic Stability
calculate_weighted_log_odds | Calculate Weighted Log Odds Ratio
calculate_word_frequency | Analyze and Visualize Word Frequencies Across a Continuous Variable
call_llm_api | Call LLM API (Unified Wrapper)
clear_lexdiv_cache | Clear Lexical Diversity Cache
cluster_embeddings | Embedding-based Document Clustering

## -- D --

describe_image | Describe Image Using Vision LLM
detect_multi_words | Detect Multi-Word Expressions
detect_pdf_content_type | Detect PDF Content Type

## -- E --

export_document_clustering | Export Document Clustering Analysis
extract_cross_category_similarities | Extract Cross-Category Similarities from Full Similarity Matrix
extract_keywords_keyness | Extract Keywords Using Statistical Keyness
extract_keywords_tfidf | Extract Keywords Using TF-IDF
extract_morphology | Extract Morphological Features
extract_named_entities | Extract Named Entities from Tokens
extract_noun_chunks | Extract Noun Chunks
extract_pos_tags | Extract Part-of-Speech Tags from Tokens
extract_subjects_objects | Extract Subjects and Objects
extract_topic_terms_df | Build a topic-term data frame from any supported topic model

## -- F --

find_optimal_k | Find Optimal Number of Topics
find_similar_words | Find Similar Words
find_topic_matches | Find Similar Topics
fit_embedding_model | Fit Embedding-based Topic Model
fit_semantic_model | Fit Semantic Model
fit_temporal_model | Fit Temporal Topic Model

## -- G --

generate_cluster_labels | Generate Cluster Label Suggestions (Human-in-the-Loop)
generate_cluster_labels_auto | Generate Cluster Labels
generate_embeddings | Generate Embeddings
generate_topic_content | Generate Content from Topic Terms
generate_topic_labels | Generate Topic Labels Using AI
get_best_embeddings | Get Best Available Embeddings
get_content_type_prompt | Get Default System Prompt for Content Type
get_content_type_user_template | Get Default User Prompt Template for Content Type
get_sentences | Get Sentences
get_spacy_model_info | Get spaCy Model Information
get_topic_prevalence | Get Topic Prevalence (Gamma) from STM Model
get_topic_terms | Select Top Terms for Each Topic
get_topic_texts | Convert Topic Terms to Text Strings
get_word_similarity | Calculate Word Similarity

## -- I --

identify_topic_trends | Identify Topic Trends
import_files | Process Files

## -- L --

lemmatize_tokens | Lemmatize Tokens with Batch Processing
lexical_analysis | Lexical Analysis Functions
lexical_diversity_analysis | Lexical Diversity Analysis
lexical_frequency_analysis | Lexical Frequency Analysis

## -- P --

plot_cluster_terms | Plot Cluster Top Terms
plot_cross_category_heatmap | Plot Cross-Category Similarity Comparison
plot_document_sentiment_trajectory | Plot Document Sentiment Trajectory
plot_emotion_radar | Plot Emotion Radar Chart
plot_entity_frequencies | Plot Named Entity Frequencies
plot_keyness_keywords | Plot Statistical Keyness
plot_keyword_comparison | Plot Keyword Comparison (TF-IDF vs Frequency)
plot_lexical_dispersion | Plot Lexical Dispersion
plot_lexical_diversity_distribution | Plot Lexical Diversity Distribution
plot_log_odds_ratio | Plot Log Odds Ratio
plot_model_comparison | Plot Topic Model Comparison Scatter
plot_morphology_feature | Plot Morphology Feature Distribution
plot_mwe_frequency | Plot Multi-Word Expression Frequency
plot_ngram_frequency | Plot N-gram Frequency
plot_pos_frequencies | Plot Part-of-Speech Tag Frequencies
plot_quality_metrics | Plot Topic Model Quality Metrics
plot_readability_by_group | Plot Readability by Group
plot_readability_distribution | Plot Readability Distribution
plot_semantic_viz | Plot Semantic Analysis Visualization
plot_sentiment_boxplot | Plot Sentiment Box Plot by Category
plot_sentiment_by_category | Plot Sentiment by Category
plot_sentiment_distribution | Plot Sentiment Distribution
plot_sentiment_violin | Plot Sentiment Violin Plot by Category
plot_similarity_heatmap | Plot Document Similarity Heatmap
plot_term_trends_continuous | Plot Term Frequency Trends by Continuous Variable
plot_tfidf_keywords | Plot TF-IDF Keywords
plot_topic_effects_categorical | Plot Topic Effects for Categorical Variables
plot_topic_effects_continuous | Plot Topic Effects for Continuous Variables
plot_topic_probability | Plot Per-Document Per-Topic Probabilities
plot_top_readability_documents | Plot Top Documents by Readability
plot_weighted_log_odds | Plot Weighted Log Odds
plot_word_frequency | Plot Word Frequency
plot_word_probability | Plot Word Probabilities by Topic
prep_texts | Preprocess Text Data
process_pdf_unified | Process PDF File (Unified Entry Point)

## -- R --

reduce_dimensions | Dimensionality Reduction Analysis
render_displacy_dep | Render displaCy Dependency Visualization
render_displacy_ent | Render displaCy Entity Visualization
run_app | Launch the TextAnalysisR app
run_rag_search | RAG Semantic Search
run_text_workflow | Complete Text Mining Workflow

## -- S --

semantic_document_clustering | Semantic Document Clustering
semantic_similarity_analysis | Semantic Similarity Analysis
sentiment_embedding_analysis | Embedding-based Sentiment Analysis
sentiment_lexicon_analysis | Analyze Sentiment Using Tidytext Lexicons
setup_python_env | Setup Python Environment
spacy_extract_entities | Extract Named Entities with spaCy
spacy_has_vectors | Check if Model Has Word Vectors
spacy_initialized | Check if spaCy is Initialized
spacy_lemmatize | Lemmatize Texts with spaCy
spacy_parse_full | Parse Texts with spaCy
SpecialEduTech | Special education technology bibliographic data
stm_15 | An example structure of a structural topic model
stopwords_list | Stopwords List
summarize_morphology | Summarize Morphology Features

## -- U --

unite_cols | Unite Text Columns

## -- V --

validate_cross_models | Cross-Analysis Validation
validate_semantic_coherence | Validate Semantic Coherence

## -- W --

word_correlation_network | Analyze and Visualize Word Correlation Networks
word_co_occurrence_network | Analyze and Visualize Word Co-occurrence Networks