Skip to content

Fix grammar and clarity in Reports documentation #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ccbogel merged 1 commit into from
Jan 21, 2026
Merged

Fix grammar and clarity in Reports documentation #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 29 additions & 29 deletions docs/doc/en/5.3.-Reports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,27 @@ path: 5.3.-Reports
* Coding comparison by file - for text files (compares 2 coders)
* Code counts by file/case
* Code frequencies (totals of applied codes)
* File summary (details of a file and it coded segments)
* File summary (details of a file and its coded segments)
* Code summary (details of a code and associated files)
* Code relations - for text files (shows proximity, exact match, overlaps, distance between selected codes)
* Code Co-occurrence - for text files (Shows counts where a code abuts/overlaps/exact-matches another code)
* Code text exact matches - for text files (Shows counts of exact matches between codes)
* Codes by text segments (Shows table of file names (rows), coded text, and codes assigned - denoted by 1).
* View graph (Create or show a graph (map) of objects and their linkages)
* Charts (Display statistical and other charts in web browser)
* Charts (Display statistical and other charts in a web browser)
* Database Queries (Database querying, including default queries)

# Coding Reports

This report gives a list, or matrix, of coded data based on your selections. One or more codes need to be selected. If a category is selected all codes in that category are also selected. Multiple categories can be selected using the mouse and the ‘ctrl’ button.
This report gives a list, or matrix, of coded data based on your selections. One or more codes need to be selected. If a category is selected, all codes in that category are also selected. Multiple categories can be selected using the mouse and the ‘ctrl’ button.

The Search button (Play Button) will present the results.

<img width="1406" height="450" alt="Code reports Screen with results" src="https://github.com/user-attachments/assets/fc6a6750-1cfe-41c4-b905-1f589876e573" />

Coding results can be narrowed down by using the File selection, Case selection or Attribute selection buttons. Only codings within the selected files or cases will be presented. When case selections are used, file selections are ignored. Also when file selections are used, case selections are ignored.

If text is entered into the Search text field, only codings which contain the matching text will be presented.
If text is entered into the Search text field, only codings that contain the matching text will be presented.
The search text also looks for matching text in memos for coded image areas and coded audio/video segments. The search text function must be used in combination with File selection, Case selection or Attribute selection.

## Important coded text, images, segments
Expand All @@ -48,7 +48,7 @@ Matrix options: have codes/categories by file or by case. The matrix can be tran

The panes can be widened or narrowed by dragging with the mouse on the bar that splits each section.

Reports can be exported to text, open document (ODT), html or csv files.
Reports can be exported to text, OpenDocument (ODT), HTML, or csv files.

<img width="1225" height="440" alt="Matrix" src="https://github.com/user-attachments/assets/fdb2702e-350e-46fe-965a-42c3d8b6652b" />

Expand All @@ -67,9 +67,9 @@ _When cases are selected, another pane is displayed showing a table of cases (in

### Memos

* Memo display. A drop-down box gives options to include no memos, various memo option, or to display text file annotations for selected text files.
* Memo display. A drop-down box gives options to include no memos, various memo options, or to display text file annotations for selected text files.

Right-click on a code heading in the generated report for more menu options: View in context, unmark, change the code.
Right-click on a code heading in the generated report for more menu options: View in context, unmark, and change the code.
![image](https://github.com/user-attachments/assets/a6d29ccf-2d9f-4faf-a1a6-5aaf3498e9a9)


Expand Down Expand Up @@ -99,13 +99,13 @@ For each code:

Agreement % shows agreement for a combination of coded and non-coded text characters.

A and B % shows agreement for the only the coded text characters divided by the total characters in the text.
A and B % shows agreement for only the coded text characters divided by the total characters in the text.

Not A and Not B % shows the total of the uncoded text divided by the total characters in the text.

Disagree % shows the percentage of all the coded and non-coded text that did not match between coders. It is the same as 100 – the Agree %.

Agree coded only % shows the percentage of all the dual coded text divided by single plus dual coded text.
Agree coded only % shows the percentage of all the dual-coded text divided by single plus dual-coded text.

Cohen’s Kappa is calculated based on the information in [Wikipédia](https://en.wikipedia.org/wiki/Cohen%27s_kappa).

Expand All @@ -115,8 +115,8 @@ Buttons to run the comparisons, to clear the coders selected, to export to Excel

# Coding Comparison by file Report

This option shows the overall similarities and differences between two coders in ONE selected file. Select one file, one code and two coders. Then click the run comparisons button. The statistics and comparisons for audio/video coded segments are in development.
Overall agreement, disagreement and Cohens Kappa are calculated for text and images. An image file is displayed in a separate window showing the two coders selections in yellow or blue boxed areas. Green text indicates where both coders coded the same section of text. Mouse hover provides additional information.
This option shows the overall similarities and differences between two coders in ONE selected file. Select one file, one code, and two coders. Then click the run comparisons button. The statistics and comparisons for audio/video coded segments are in development.
Overall agreement, disagreement, and Cohen's Kappa are calculated for text and images. An image file is displayed in a separate window, showing the two coders' selections in yellow or blue-boxed areas. Green text indicates where both coders coded the same section of text. Mouse hover provides additional information.

![image](https://github.com/user-attachments/assets/cd5eff94-2cc0-4988-af48-da12f55bfc48)

Expand All @@ -131,16 +131,16 @@ This window shows all the codes and categories and the frequency of use for each

This dialog shows the relations between two or more codes. This can only be applied to text files.
Select two or more codes, and press the Calculate button.
his report may be useful to show proximity or overlaps between codes. Note, other reports such as Code Co-occurrence and Code Text Exact Matches also do this. This report give a lot of fine details, such as the coding character positions for each code.
his report may be useful to show proximity or overlaps between codes. Note, other reports such as Code Co-occurrence and Code Text Exact Matches also do this. This report gives a lot of fine details, such as the coding character positions for each code.
A csv file can be exported.


The relations are:

* Proximity – Two codes do not overlap. The distance in number of characters is shown.
* Overlap – Two codes partially overlap. The lowest and highest character positions of the combination are shown. The union of the overlapping section is shown in character positions.
* Inclusion – One code is included within another code. The lowest and highest character positions of the combination are shown. The union of the overlapping section is shown in character positions.
* Exact – Both codes match in their start and end positions. The lowest and highest character positions of the combination are shown. The union of the overlapping section is shown in character positions.
* Overlap – Two codes partially overlap. The lowest and highest character positions of the combination are shown. The union of the overlapping sections is shown in character positions.
* Inclusion – One code is included within another code. The lowest and highest character positions of the combination are shown. The union of the overlapping sections is shown in character positions.
* Exact – Both codes match in their start and end positions. The lowest and highest character positions of the combination are shown. The union of the overlapping sections is shown in character positions.


<img width="1720" height="300" alt="Code relations tables" src="https://github.com/user-attachments/assets/ef6e5e65-3681-4557-bcff-12255aa8c70d" />
Expand All @@ -155,43 +155,43 @@ Summary statistics and box plots can be produced.

This report shows a table of code names along the x and y axes. The table cells show the count of coding co-occurrences. This is where two codes overlap or are directly abutting. Click on the cell to show the text coding details.

Options include: selecting specific text files, selecting files by attributes. Selecting specific codes, or selecting categories. There is an export to Excel option.
Options include: selecting specific text files, selecting files by attributes. Selecting specific codes, or selecting categories. There is an export-to-Excel option.

<img width="1480" height="300" alt="Code co-occurrence table" src="https://github.com/user-attachments/assets/9def2cc2-3627-47b7-a74d-92e842aea167" />

Clicking on a cell shows the text details.
![image](https://github.com/user-attachments/assets/fadccf7b-d18b-44a9-8637-650ea3421f66)

In version 3.8 plus, you can right-click on a cell containing co-occurrence coded text, to make a new merged code, that combines the two overlapping codes.
In version 3.8 plus, you can right-click on a cell containing co-occurrence coded text to make a new merged code that combines the two overlapping codes.

# File Summary Report

Click on a file to get a summary of that file. It describes media metadata, characters and word frequency. Attributes. It summarises the count of codes for that file. For text codings is summarises the average text length. For image codings it summarises the average pixel area. For audio/video codings it summarises the average segment length.
Click on a file to get a summary of that file. It describes media metadata, characters and word frequency. Attributes. It summarises the count of codes for that file. The text codings summarize the average text length. For image codings it summarises the average pixel area. For audio/video codings it summarises the average segment length.

The top 100 words has stopwords applied - so common filler words such as 'a', 'the' etc are excluded. See the list in the _Examples folder_. You can over-ride this list by providing your own stopwords text file and placing this in the _.qualcoder folder_.
The top 100 words have stopwords applied - so common filler words such as 'a ', 'the', etc. are excluded. See the list in the _Examples folder_. You can override this list by providing your own stopwords text file and placing this in the _.qualcoder folder_.

<img width="1128" height="650" alt="File summary report" src="https://github.com/user-attachments/assets/73d17c0b-2dd4-4df8-ae16-abc8683ca171" />

# Code Summary Report

Click on a code to get a summary of that code. The coders who have used the code. The number of codings in text, image and audio/video media. For text codings is summarises the average text length and the most common words. For image codings it summarises the average pixel area. For audio/video codings it summarises the average segment length.
Click on a code to get a summary of that code. The coders who have used the code. The number of codings in text, image and audio/video media. The text codings summarize the average text length and the most common words. For image codings it summarises the average pixel area. For audio/video codings it summarises the average segment length.

The top 100 words has stopwords applied - so common filler words such as 'a', 'the' etc are excluded. See the list in the _Examples folder_. You can over-ride this list by providing your own stopwords text file and placing this in the _.qualcoder folder_.
The top 100 words have stopwords applied - so common filler words such as 'a ', 'the', etc. are excluded. See the list in the _Examples folder_. You can override this list by providing your own stopwords text file and placing this in the _.qualcoder folder_.

<img width="1125" height="550" alt="Code summary report" src="https://github.com/user-attachments/assets/9a303fb2-bdfe-43a3-aa35-2034bd8c0abb" />

# Code text by exact matches Report

This report details all the exact matching coded text segments, where different codes are applied to the exact same text. Select text documents, and two or more codes.
This report details all the exact matching coded text segments, where different codes are applied to the exact same text. Select text documents and two or more codes.

![image](https://github.com/user-attachments/assets/284f388e-f561-416e-accb-ec18ad509944)


# Codes by text segments Report

This report shows rows of coded text segments and columns of which code has been applied.
For some users, e.g. legal area, it is convenient to see which codes have been applied to the same text segment.
A Excel file can be exported.
For some users, e.g., legal area, it is convenient to see which codes have been applied to the same text segment.
An Excel file can be exported.

![image](https://github.com/user-attachments/assets/226f7c7d-f343-46d7-a2a7-49d86bfa3ef2)

Expand Down Expand Up @@ -241,7 +241,7 @@ There are a list of stop words that are used to exclude common words from the wo

"C:\Users\yourname\.qualcoder"

The stopwords currently used are in stopwords.txt in the Examples folder. Altaernatively in 3.8+ you can use the button in the Wordcloud section to temporarily link to another stopwords file of your choosing.
The stopwords currently used are in stopwords.txt in the Examples folder. Alternatively, in 3.8+, you can use the button in the Wordcloud section to temporarily link to another stopwords file of your choosing.

![Word Cloud](https://qualcoder.wordpress.com/wp-content/uploads/2023/12/wc.png)

Expand All @@ -263,13 +263,13 @@ Most table fields are text. The following fields are integer: anid, avid, attrid

Right-click in the results table for filtering options.

Right click in the SQL window give you various options such as select all, copy, paste.
Right-clicking in the SQL window gives you various options such as select all, copy, and paste.

At the bottom of the left hand side list, you can see: stored sql and Default queries
At the bottom of the left-hand side list, you can see: stored sql and Default queries

Stored sql are you own created and stored sql statements. To store a sql statement, right-click on the sql and choose 'save query'.
Stored sql are your own created and stored sql statements. To store a sql statement, right-click on the sql and choose 'save query'.

Default queries, such as the one shown in the image, are ready made sql to do additional extracts from your data. They are commented '-- a comment' to describe what each statement does.
Default queries, such as the one shown in the image, are ready-made SQL queries to perform additional extracts from your data. They are commented '-- a comment' to describe what each statement does.

![image](https://github.com/user-attachments/assets/18c552a3-b256-453a-80ec-5c2931016e12)

Expand Down