Metadata-Version: 2.1
Name: AutoThemeGenerator
Version: 0.0.7
Summary: Performing thematic analysis with OpenAI's GPT-4 models
Author: Charles Alba
Author-email: alba@wustl.edu
Keywords: GPT models,Thematic analysis,OpenAI,Qualitiative studies,transcripts,interviews
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Education
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: textract
Requires-Dist: openai ==1.12.0
Requires-Dist: nltk ==3.8.1
Requires-Dist: requests ==2.31.0
Requires-Dist: python-docx
Requires-Dist: docx
Requires-Dist: tqdm
Requires-Dist: zipfile
Requires-Dist: requests

AutoThemeGenerator is a package that allows you to perform thematic analysis in qualitative studies using OpenAI's GPT models. 





<p align="center">

  <a href="https://cja5553.github.io/ReadTheDocs_AutoThemeGenerator/">

    <img src="https://img.shields.io/badge/Documentation-v0.0.7-orange" alt="Documentation">

  </a>

  <a href="https://pypi.org/project/AutoThemeGenerator/">

    <img src="https://img.shields.io/badge/pypi_package-v0.0.7-brightgreen" alt="pypi package">

  </a>

  <a href="https://github.com/cja5553/AutoThemeGenerator">

    <img src="https://img.shields.io/badge/github_source_code-source_code?logo=github&color=green" alt="GitHub Source Code">

  </a>

  <a href="https://colab.research.google.com/drive/1BoAI-QNL-yL8j8hUJ3K8cJkbyp4spoQ3">

    <img src="https://img.shields.io/badge/-Colab_Example-grey?logo=google&logoColor=F9AB00" alt="Colab Example">

  </a>

</p>





## User inputs

Users are only required to specify the folder location where their interview transcripts are stored. Accepted formats of transcripts include `PDF`, `.docx`, and `.txt` (prefered). `AutoThemeGenerator` assumes that each document is a transcript of one interviewed participant.



## Requirements

### Required packages

To use `AutoThemeGenerator`, you are required to have the following packages installed:  

- `openai`  

- `docx`    

- `tqdm`    

- `nltk`    

- `nltk.tokenize`    

- `python-docx`  

- `textract`  

- `zipfile`  

- `shutil`  

- `requests`  

- `json`  



If you do not have this packages installed in python, you can do the following:

```bash

pip install openai docx tqdm nltk nltk.tokenize python-docx textract zipfile shutil requests json

```

### OpenAI API key

You also need an OpenAI key to be able to use this package. If you do not have one, you can apply for an OpenAI API key at [platform.openai.com/api-keys](https://platform.openai.com/api-keys). 



## Installation

To install in python, simply do the following: 

```bash

pip install AutoThemeGenerator

```



## Quick Start

Here we provide a quick example on how you can execute `AutoThemeGenerator` to conveniently perform qualitative analysis from your transcript. For details towards each of the package's functions and parameters, refer to the [documention](documention.md). 

```python

from AutoThemeGenerator import analyze_and_synthesize_transcripts



# Specify the folders containing your transcript

# This is the folder containing transcripts in .docx, .PDF or .txt format

directory_path = "my_transcript_folder"

# specify your OpenAI API key

api_key = "<insert your API key>"

# specify the folder you wish to save your themes. 

save_results_path = "folder_of_my_saved_results"



# specify the context of your study

context = (

    "Physical inactivity is a major risk factor for developing several chronic illness. "

    "However, university students and staff in the UK are found to be more physically inactive "

    "compared the general UK population. "

    )

# specify your research questions

research_questions = (

    "This study seeks to understand the barriers and enablers "

    "of physical activity (PA) among university staff and students in "

    "the UK under the university setting, using the Theoretical "

    "Domain Framework (TDF) to guide the investigation. "

    )

# specify your survey script

survey_script = (

    "Knowledge\n "

    "What do you know about physical activity? How might you define physical activity? "

    "... ..." # note: truncated to save space

    "... ..." 

    )



# Analyze and synthesize transcripts

initial_themes, individual_synthesized_themes, overall_synthesized_themes = \

analyze_and_synthesize_transcripts(

    directory_path = directory_path, context = context,

    research_questions = research_questions, script = survey_script,

    api_key = api_key, save_results_path = save_results_path)



# display your study-level themes

print(overall_synthesized_themes)

```

You can now view the themes in the form of a topic sentence, a detailed explaination and a relevant quote



## Citation

Y Yang, C Alba, W Xi, M Li, C Wang, A Jami, R An. "GPT Models Can Perform Thematic Analysis in Public Health Studies, Akin to Qualitative Researchers" Working paper. 



# Questions?



Contact me at [alba@wusl.edu](mailto:alba@wusl.edu)
