Skip to content

Commit 0d05888

Browse files
committed
updated READMEs
1 parent 0f8c843 commit 0d05888

File tree

5 files changed

+40
-94
lines changed

5 files changed

+40
-94
lines changed

README.md

Lines changed: 22 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -112,15 +112,17 @@ DATS is still under development, so please feel free to give us feedback, tell u
112112
- For feedback, please write [us](https://www.inf.uni-hamburg.de/en/inst/ab/lt/people/tim-fischer.html)
113113
- To report bugs, please open an issue on [GitHub](https://github.com/uhh-lt/dats/issues)
114114

115-
## Features
115+
<br/>
116+
117+
# Features
116118

117-
### Data collection
119+
## Data collection
118120

119121
DATS can handle most data formats for text, image, audio, and video documents.
120122
You can easily upload your files to DATS.
121123
It also offers an integrated crawler implemented with Scrapy and Beautifulsoup to scrape websites and their images in case additional material is required.
122124

123-
### Data pre-processing
125+
## Data pre-processing
124126

125127
<!-- <div align="center" style="margin: 10px">
126128
<img src="./assets/feature-preprocessing.png" alt="Pre-processing" />
@@ -136,39 +138,31 @@ This process extracts metadata and enriches the material with additional informa
136138
- Image captioning
137139
- Automatic speech recognition (transcription)
138140

139-
This powerful feature enables you to precisely filter documents by keywords, entities, and other criteria later on.
140-
141-
### Data management
141+
This feature enables you to precisely filter documents by keywords, entities, and other criteria later on.
142142

143-
![Data-management](assets/feature-data-management.png)
143+
## Data management
144144

145-
<div style="width: 67%; float: left">
145+
<img src="assets/feature-data-management.png" alt="Data Management in DATS" title="Data Management in DATS" />
146146

147147
DATS makes it easy to organize and analyze your data.
148148
Each document can be assigned metadata – some of which DATS detects automatically – to help you categorize and find what you need.
149149
You can also add your own tags to documents.
150150

151-
Powerful filtering and search options let you quickly sift through your data.
151+
Filtering and search options let you quickly sift through your data.
152152
Find documents containing specific keywords, entities (like people, organizations, or locations), or other criteria.
153153
This flexible system keeps you in control of your data and ensures you can quickly find the information that matters most to your research.
154154

155+
<img src="assets/feature-llm-assistance-tagging.png" alt="AI Assistance in DATS for Document Tagging" title="AI Assistance in DATS for Document Tagging" height="400px" />
156+
155157
DATS offers an AI Assistant that can help you streamline your data management tasks.
156158
The AI Assistant can suggest tags and extract metadata for your documents, making it even easier to organize data.
157159

158160
Read more about LLM Assistance in our publlication [Exploring Large Language Models for Qualitative Data Analysis](https://aclanthology.org/2024.nlp4dh-1.41/).
159161

160-
</div>
161-
162-
<div style="width: 33%; float: left;">
163-
164-
![LLM-Assistance-Tags](assets/feature-llm-assistance-tagging.png)
165-
166-
</div>
167-
168-
### Exploration
162+
## Exploration
169163

170164
DATS makes exploring your data easy and intuitive.
171-
Its powerful similarity search allows you to quickly find related documents, even across different modalities.
165+
Its similarity search allows you to quickly find related documents, even across different modalities.
172166

173167
Found an interesting article? DATS can instantly find others like it.
174168
Discovered a key image? DATS can locate similar images, or even text documents that relate to the same concept.
@@ -182,7 +176,7 @@ This frequency analysis feature allows you to:
182176
- Discover new avenues for research: Identify potentially relevant keywords or entities you hadn't previously considered.
183177
- Refine your searches: Use the frequency list to add new search terms or filters, leading you to new documents and a deeper understanding of your corpus.
184178

185-
### Annotation
179+
## Annotation
186180

187181
DATS provides tools for text (span & sentence) and image annotation.
188182
Annotating audio and video documents directly is not (yet) supported.
@@ -194,24 +188,24 @@ For example, the sentence annotator enables you to:
194188
- Develop a code hierarchy: Create a structured taxonomy of codes and sub-codes to organize your analysis. DATS's interface - allows you to easily manage and update this code hierarchy as your research evolves.
195189
- Collaborate with others: Codes and annotations are shared with colleagues, fostering teamwork and discussion.
196190

197-
![Sentence-Annotation](assets/feature-sentence-annotation.png)
191+
<img src="assets/feature-sentence-annotation.png" alt="Sentence Annotation in DATS with AI Assistance" title="Sentence Annotation in DATS with AI Assistance" />
198192

199193
The AI Assistant integrated in DATS can also help you with the annotation process.
200194
It can suggest relevant text annotations, which you can then review and accept or reject.
201195
This can save you a lot of time and effort, especially if you are working with a large dataset.
202196

203197
Read more about the Sentence Annotation feature in our publication [Semi-automatic Sequential Sentence Classification in the Discourse Analysis Tool Suite](https://www.inf.uni-hamburg.de/en/inst/ab/lt/people/tim-fischer.html).
204198

205-
### Analysis
199+
## Analysis
206200

207201
DATS offers various tools for qualitative and quantitative analysis including Word- and Code-Frequency, or timeline analyses.
208202
The more-advanced Concept-over-time analysis is explained below.
209203

210-
#### Concept-over-time Analysis
204+
### Concept-over-time Analysis
211205

212-
![Concept-Over-Time-Analysis](assets/feature-cota-timeline.png)
206+
<img src="assets/feature-cota-timeline.png" alt="Concept Over Time Analysis in DATS" title="Concept Over Time Analysis in DATS" />
213207

214-
DATS includes Concept Over Time Analysis, a powerful feature that allows you to visualize how concepts evolve over time within your data.
208+
DATS includes Concept Over Time Analysis, a feature that allows you to visualize how concepts evolve over time within your data.
215209
With the Concept Over Time Analysis feature, you can:
216210

217211
- Define and refine your concepts of interest.
@@ -228,7 +222,7 @@ Finally, the occurrence of the concept over time analysis are visualized.
228222
DATS's Concept Over Time Analysis is a valuable tool for qualitative data analysis, providing a unique perspective on the dynamics of discourse.
229223
Read more about COTA in our publication [Concept Over Time Analysis: Unveiling Temporal Patterns for Qualitative Data Analysis](https://aclanthology.org/2024.naacl-demo.15/).
230224

231-
### Interpretation
225+
## Interpretation
232226

233227
![Whiteboard](assets/feature-whiteboard.png)
234228

@@ -242,9 +236,9 @@ With Whiteboards, you can:
242236

243237
To use Whiteboards, you simply drag and drop your research objects onto the canvas. You can then connect them with edges to represent relationships between them. You can also add text, shapes, and images to your Whiteboards to further annotate your data. Whiteboards are a powerful way to interact with your data, making it easier to conduct qualitative data analysis and uncover hidden connections.
244238

245-
Read more about the Whiteboards in our publication [ Extending the Discourse Analysis Tool Suite with Whiteboards for Visual Qualitative Analysis](https://aclanthology.org/2024.lrec-main.615/).
239+
Read more about the Whiteboards in our publication [Extending the Discourse Analysis Tool Suite with Whiteboards for Visual Qualitative Analysis](https://aclanthology.org/2024.lrec-main.615/).
246240

247-
### Reflection
241+
## Reflection
248242

249243
DATS provides tools for reflection and documentation that are seamlessly integrated into your workflow, helping you to capture and organize your thoughts throughout the research process:
250244

assets/banner.html

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@
1111
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
1212
<title>Discourse Analysis Tool Suite</title>
1313
<style>
14-
body {
14+
.container {
1515
display: flex;
1616
justify-content: center;
1717
align-items: center;
1818
height: 100vh;
19-
background-color: #111;
19+
background-color: transparent;
2020
font-family: "Roboto", serif;
2121
}
2222

@@ -31,7 +31,7 @@
3131
background: linear-gradient(to top right, #42a5f5, #7b1fa2);
3232
padding: 20px;
3333
color: white;
34-
box-shadow: 0 5px 15px rgba(0, 0, 0, 0.2);
34+
box-shadow: 0px 0px 8px rgba(255, 255, 255, 1);
3535
}
3636

3737
.logo {
@@ -107,19 +107,21 @@
107107
</style>
108108
</head>
109109
<body>
110-
<div class="banner">
111-
<div class="logo">
112-
<div class="dot"></div>
113-
<div class="dot"></div>
114-
<div class="dot"></div>
115-
<div class="dot"></div>
116-
<div class="dot"></div>
117-
<div class="dot"></div>
118-
<div class="dot"></div>
119-
</div>
120-
<div class="text">
121-
<div class="title">Discourse Analysis Tool Suite</div>
122-
<div class="subtitle">Developed by LT</div>
110+
<div class="container">
111+
<div class="banner">
112+
<div class="logo">
113+
<div class="dot"></div>
114+
<div class="dot"></div>
115+
<div class="dot"></div>
116+
<div class="dot"></div>
117+
<div class="dot"></div>
118+
<div class="dot"></div>
119+
<div class="dot"></div>
120+
</div>
121+
<div class="text">
122+
<div class="title">Discourse Analysis Tool Suite</div>
123+
<div class="subtitle">Developed by LT</div>
124+
</div>
123125
</div>
124126
</div>
125127
</body>

assets/banner.png

320 KB
Loading

backend/README.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

frontend/README.md

Lines changed: 0 additions & 44 deletions
This file was deleted.

0 commit comments

Comments
 (0)