Repository files navigation

textAnnotatoR provides an interactive graphical user interface forqualitative text analysis in R. The package allows researchers,students, and practitioners to annotate text, manage codes, creatememos, and visualize coding patterns through an intuitive Shinyinterface.

• Interactive Text Annotation: Select and code text segmentsdirectly within the GUI
• Code Management: Create, organize, and merge codes with ahierarchical structure
• Theme Organization: Group related codes into themes with atree-based hierarchy
• Memo Creation: Attach notes and observations to annotations
• Advanced Visualization: Analyze code frequencies, co-occurrences,and patterns
• Comparison Tools: Compare coding patterns between different codersor documents
• Project Management: Save, load, and manage annotation projects
• Export Options: Save annotations and coded text in various formats(CSV, JSON, HTML)
• R Integration: Seamlessly combine with other R packages foradvanced analysis

# Install from CRANinstall.packages("textAnnotatoR")# Or install the development version from GitHub# install.packages("devtools")devtools::install_github("chaoliu-cl/textAnnotatoR")

Launch the annotation interface with a simple function call:

library(textAnnotatoR)annotate_gui()

This opens the Shiny application in your default web browser. Theinterface includes a toolbar for project management, a tabbed main areafor different functions, and a text display area.

1. Create a New Project: Click “New Project” in the top toolbar
2. Import Text: Go to the “File” tab, upload your text document(.txt, .docx, .pdf)
3. Annotate Text: Select text segments and apply codes
4. Organize Codes: Create a hierarchical structure of themes andcodes
5. Analyze Patterns: Use the analysis tools to explore your coding
6. Export Results: Save your annotations and analysis for furtheruse

Comprehensive documentation is available through vignettes:

# List available vignettesvignette(package="textAnnotatoR")# Read specific vignettesvignette("practical_example",package="textAnnotatoR")vignette("technical_integration",package="textAnnotatoR")

Create and manage hierarchical code structures with themes andsubthemes:

• Use “Add Theme” to create organizational categories
• Group related codes under appropriate themes
• Visualize the hierarchy in a tree structure

Explore relationships between different codes:

• Identify patterns of code co-occurrence
• Visualize connections through network graphs
• Examine statistical measures of code relationships

Compare coding patterns between different coders or documents:

• Upload two annotation sets
• Analyze similarities and differences
• Visualize comparative patterns

Export your annotations in various formats:

• CSV for quantitative analysis
• JSON for web applications
• HTML for formatted viewing with code highlighting

textAnnotatoR is designed to work seamlessly with other R packages:

• tidytext: For text mining and natural language processing
• quanteda: For advanced text analysis
• igraph/ggraph: For network visualizations of code relationships
• rmarkdown/shiny: For reporting and interactive dashboards

• R version 4.0.0 or higher
• Shiny and its dependencies
• A modern web browser

The package includes comprehensive automated tests for corefunctionality, data processing, and utility functions. While testinginteractive Shiny components presents unique challenges, the packagemaintains good test coverage for the underlying logic and datamanipulation functions that power the user interface. Interactivecomponents are validated through manual testing and user feedback.

Contributions totextAnnotatoR are welcome! Please feel free to submitissues or pull requests on GitHub.

This package is licensed under the GPL-3 License.

• Issues: Please report issues on theGitHub issuespage
• Email:chaoliu@cedarville.edu
• X:@X