Skip to content

Commit 2fd19f9

Browse files
add data_ethics, etc + reorder the table of content
1 parent e275294 commit 2fd19f9

File tree

1 file changed

+37
-17
lines changed

1 file changed

+37
-17
lines changed

README.md

Lines changed: 37 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,14 @@ An easy-to-use toolkit for visualizing patterns in qualitative data, helping res
1919
- [Data Structure](#data-structure)
2020
- [Troubleshooting](#troubleshooting)
2121
- [Uninstallation](#uninstallation)
22-
- [License](#license)
2322
- [Training Resources](#training-resources)
2423
- [References](#references)
25-
- [Disclosure](#disclosure)
24+
- [Policies](#policies)
25+
- [License](#license)
26+
- [Authors](#authors)
27+
- [Acknowledgments](#acknowledgments)
28+
- [Data Ethics](#data-ethics)
29+
- [Disclaimer](#disclaimer)
2630

2731
## Overview
2832
The CMAP Visualization Toolkit offers a free suite of open-source tools to analyze and visualize text data: including fieldnotes, in-depth interview transcripts, historical documents, web-pages, and other forms of non-numeric information. It is designed for scholars working with qualitative methods, who have an interest in the possibilities for pattern analysis, data visualization, and identifying alternative explanations found in computational social science's (CSS).
@@ -36,7 +40,7 @@ The CMAP (Cultural Mapping and Pattern Analysis) tool is free, open-source and p
3640
For an introduction, in an easy to use online version (not for sensitive data) check out the collab version [here](https://colab.research.google.com/drive/1n90EDMSiXhIaOULUMPJ4W4hqdZCh1NQw?usp=sharing)
3741
---
3842

39-
## Toolkit Capabilities
43+
## What This Toolkit Does
4044

4145
This notebook introduces elements of visualizing text data from qualitative sources and provides tools for:
4246
- Validating text data
@@ -79,7 +83,7 @@ CMAP Visualization Toolkit supports advanced analytic methods that are appropria
7983

8084
**⚠️ IMPORTANT**: This toolkit requires Anaconda or Miniconda to be installed on your system. If you don't have it yet, [download and install Anaconda](https://www.anaconda.com/products/distribution) or [download and install Miniconda](https://docs.conda.io/en/latest/miniconda.html) before proceeding.
8185

82-
### Initial Installation (Easiest Method)
86+
### One-Command Installation (Easiest Method)
8387

8488
For the simplest installation, follow these steps:
8589

@@ -428,17 +432,6 @@ To remove the CMAP Visualization Toolkit from your system:
428432

429433
This will completely remove all toolkit components from your system.
430434

431-
## License
432-
See [LICENSE.md](./LICENSE.md).
433-
BSD 3-Clause License
434-
Copyright (c) 2025 Computational Ethnography Lab (Abramson et al.)
435-
436-
**Important**: If you use this software, please cite as: "Abramson, Corey and Yuhan (Victoria) Nian. 2025. CMAP Visualization Toolkit. https://github.com/Computational-Ethnography-Lab/cmap_visualization_toolkit."
437-
438-
Key contributors: Yuhan (Victoria) Nian, Zhuofan Li, Tara Prendergast, Jakira Silas, and others.
439-
440-
No warranty is provided. If you want to contribute, please email corey.abramson@rice.edu.
441-
442435
## Training Resources
443436

444437
### Anaconda Setup Videos
@@ -452,8 +445,35 @@ For more detailed information, refer to the [Anaconda Documentation](https://doc
452445

453446
This toolkit builds on academic work combining computational text analysis with qualitative research methods (Abramson et al. 2018, 2025). Please see the [lab repo](https://github.com/Computational-Ethnography-Lab) for additional resources and related research papers.
454447

455-
## Disclosures
448+
# Policies
449+
## License
450+
See [LICENSE.md](./LICENSE.md).
451+
BSD 3-Clause License
452+
Copyright (c) 2025 Computational Ethnography Lab (Abramson et al.)
453+
454+
**Important**: If you use this software, please cite as: "Abramson, Corey and Yuhan (Victoria) Nian. 2025. CMAP Visualization Toolkit. https://github.com/Computational-Ethnography-Lab/cmap_visualization_toolkit."
455+
456+
Key contributors: Yuhan (Victoria) Nian, Zhuofan Li, Tara Prendergast, Jakira Silas, and others.
457+
458+
No warranty is provided. If you want to contribute, please email corey.abramson@rice.edu.
459+
460+
### Authors
461+
- Corey M. Abramson, Ph.D. — Associate Professor of Sociology, Rice University; PI, Computational Ethnography Lab; Co-Director, CIISR
462+
- Yuhan (Victoria) Nian — Undergraduate Student, Statistics & Data Science, Rice University
463+
- Zhuofan Li, Ph.D. — Assistant Professor of Sociology, Virginia Tech
464+
- Tara Prendergast — Ph.D. Candidate, School of Sociology, University of Arizona
465+
- Jakira Silas — Graduate Student, Sociology, Rice University
466+
467+
468+
### Acknowledgments
469+
We thank all contributors to the Computational Ethnography Lab GitHub repository for their valuable feedback, testing, and improvements. This includes everyone with contributions to the public repository, in addition to the key authors listed above. Special thanks to the broader Computational Ethnography Lab community for ongoing support.
470+
471+
### Data Ethics
472+
See [data_ethics.md](./DATA_ETHICS.md) for details on ethical considerations, including data anonymization, consent, and use restrictions.
456473

474+
### Disclaimer
475+
See [DISCLAIMER.md](./DISCLAIMER.md) for important legal and usage disclaimers.
476+
### Disclosures
457477
- LLMs (primarily Claude-Sonnet) were used to check for errors and help annotate code.
458478
- If you find errors or are interested in collaboration, contact corey.abramson@rice.edu.
459-
- This free software carries no warranty or guarantee—like life.
479+
- This free software carries no warranty or guarantee—like life.

0 commit comments

Comments
 (0)