Skip to content

Commit eecebad

Browse files
committed
Update aggregations.md
1 parent f38d0e2 commit eecebad

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

docs/aggregations.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,11 @@ parameters for which the aggregation is provided
3030
- a distribution of all distinct values/combinations with the count of their occurrence
3131
* an optional `scope` parameter to indicate the entity the results refer to (usually the current entry type but might be variable for collection and overview aggregations)
3232

33-
### Examples
34-
3533
The following examples display different aggregation objects (which would be items in the `responseAggregation` array). Note that **id values are for demonstration only** and do not have a normative function.
3634

3735
**Aggregations and Queries:** For most of the example cases one can envision both a use in "data overview context" (e.g. to profile the content of a resource or collection) and in "query context" (e.g. to profile the response for a specific query).
3836

39-
#### Minimal Representation of Distinct Values Count `distinctValuesCount`
37+
### Example: Minimal Representation of Distinct Values Count `distinctValuesCount`
4038

4139
How many different diseases are represented in the data?
4240

@@ -49,7 +47,7 @@ How many different diseases are represented in the data?
4947
}
5048
```
5149

52-
#### Informative Values `anyValueCount`
50+
### Example: Informative Values `anyValueCount`
5351

5452
How many individuals in the data have a follow-up time?
5553

@@ -63,7 +61,7 @@ How many individuals in the data have a follow-up time?
6361
}
6462
```
6563

66-
#### Value Distribution `distribution`, Single Concept
64+
### Example: Value Distribution `distribution`, Single Concept
6765

6866
What is the distribution of diseases in the samples?
6967

@@ -100,10 +98,11 @@ What is the distribution of diseases in the samples?
10098
}
10199
```
102100

103-
#### Value Distribution `distribution`, Intersecting Concepts
101+
### Example: Value Distribution `distribution`, Intersecting Concepts
104102

105103
What is the distribution of diseases in the samples, separately by sex?
106104
Please note:
105+
107106
* there are now 2 concepts in the `concepts` list and the `conceptValues` in the distribution are observed combinations of values for both concepts, in the same order
108107
* the `count` indicates the number of times this combination was observed (e.g. 426 cases of "male" & "Prostate Adenocarcinoma" but 0 cases for "female" & "Prostate Adenocarcinoma")
109108

0 commit comments

Comments
 (0)