Installation

If you haven’t installed textAnnotatoR yet, you can install it from GitHub:

# Install devtools if not already installed
if (!requireNamespace("devtools", quietly = TRUE)) {
  install.packages("devtools")
}

# Install textAnnotatoR
devtools::install_github("chaoliu-cl/textAnnotatoR")

First-Time Setup

The first time you run textAnnotatoR, it will ask you to confirm where you want to store your project data:

library(textAnnotatoR)
annotate_gui()

You’ll see a dialog asking you to choose between: 1) Default Location: A folder managed by R in your user directory 2) Custom Location: A directory of your choice 3) Project-specific Location: A customizable directory unique to each project

Understanding the Interface

When textAnnotatoR launches, you’ll see several tabs:

• File: Import text and manage projects
• Code and Memo: For managing codes and adding memos
• Themes: Organize codes into themes and hierarchies
• Analysis: Analyze coding patterns
• Records: View all annotations in tabular format
• Comparison: Compare coding between different coders

Step 1: Creating a New Project

When you first launch textAnnotatoR, it automatically creates a blank project. However, if you want to start a new project, click “New Project” in the top toolbar

If you have unsaved changes in your current project, you’ll see a confirmation dialog asking if you want to save your current project first:

Step 2: Importing Text Data

For this example, we’ll use the following interview excerpt. You can copy this text into a file named remote_work_interview.txt:

Interviewer: Can you describe your experience transitioning to remote work?

Participant: It was definitely challenging at first. I think the biggest issues were setting up a proper workspace at home and establishing boundaries between work and personal life. It took me about a month to develop a routine that worked. Now, I actually prefer working remotely. I'm more productive without office distractions, and I save two hours daily by not commuting.

Interviewer: What tools or resources have been most helpful?

Participant: Video conferencing has been essential - we use Zoom for all our meetings. We also rely heavily on Slack for quick communications and Asana for project management. My company provided a second monitor and an ergonomic chair, which made a huge difference in my physical comfort. I'd say the technology was easy to adapt to, but the social aspects were harder. It's difficult to replace those impromptu conversations by the coffee machine.

Interviewer: How has remote work affected your work-life balance?

Participant: It's a double-edged sword. I have more flexibility and time with family, but it's also harder to disconnect. Sometimes I find myself checking emails well into the evening, which wasn't a habit before. I've had to be intentional about setting working hours and sticking to them. Taking short walks during the day has become my substitute for the natural breaks that happened in the office.

Step 3: Saving Your Project

It’s important to save your project regularly. To do that, click on “Save Project”

Then, a dialog will appear:

• Type in your project name
• Click “Choose Directory” to select where to save the project
• Directories are displayed in a hierarchical format - navigate to your desired location
• Click “Save” to save your project

The project will be saved as an RDS file, which preserves all your annotations, codes, and project structure.

Step 4: Annotating the Text

Now let’s start coding our interview text:

1. Click the selection tool (cursor icon) in the right margin
2. Select text discussing the home workspace setup
3. In the “Code and Memo” tab, enter “Home Setup” as the code
4. Add a memo: “Initial challenge in transition to remote work”
5. Click “Save” to save the code

Continue this process for other notable segments in the text. For example:

• Code Zoom, Slack, and Asana as “Technology”
• Code “save two hours daily by not commuting” as “Save Time”
• Code discussions of missed impromptu conversations as “Social Isolation”

Your annotated text will begin to look like this, with different colored highlights representing different codes:

Step 5: Loading Your Project

If you need to continue your work later, you’ll need to load your saved project: Click “Load Project”.

Then a dialog will appear:

• Click “Choose Project File” to navigate to your saved project file
• Navigate through the directory structure to find your project
• Select the RDS file and click “Select”
• Click “Load” to load your project

All your text, annotations, codes, and memos will be restored exactly as you left them.

Step 6: Analyzing the Coded Data

Once you’ve coded the entire interview, use the analysis tools to examine patterns:

Step 7: Creating Themes

Sometimes multiple codes may share the same underlying theme and you may want to create a theme that encompasses several codes. Let’s create a logical hierarchy of themes and codes. Go to the “Themes” tab:

1. Click “Add Theme” and create the following themes:

   • “Challenges”
   • “Benefits”
   • “Tools”
   • “Work-Life Balance”

2. For each theme, add relevant codes:

   For “Challenges”:

   • Click “Add Code to Theme”
   • Select “Challenges” as the parent theme
   • Add codes like “Technical Issues”, “Social Isolation”, “Home Setup”

When finished, your code hierarchy should look something like this:

Step 8: Exporting Results

Step 9: Project Comparison (Two Coders)

If you’re working with a team where two researchers code the same text, you can use the comparison tools:

1. Have each team member code the interview independently
2. Save each person’s annotations as CSV files
3. Go to the “Comparison” tab
4. Upload both CSV files
5. Run the comparison to see inter-coder agreement and differences