Skip to content

Commit 9534dd4

Browse files
DilumAluthgeDilumAluthge
authored
Reorganize docs (#8)
1 parent 817ac07 commit 9534dd4

5 files changed

Lines changed: 90 additions & 70 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,6 @@
55
[![Build Status](https://github.com/JuliaHealth/OMOPCommonDataModel.jl/workflows/CI/badge.svg)](https://github.com/JuliaHealth/OMOPCommonDataModel.jl/actions)
66
[![Coverage](https://codecov.io/gh/JuliaHealth/OMOPCommonDataModel.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaHealth/OMOPCommonDataModel.jl)
77

8-
Pure Julia implementation of the [OMOP Common Data Model (CDM)](https://github.com/OHDSI/CommonDataModel) version 6.0.
8+
Pure Julia implementation of the [OMOP Common Data Model (CDM)](https://github.com/OHDSI/CommonDataModel).
9+
10+
Please see the [documentation](https://JuliaHealth.github.io/OMOPCommonDataModel.jl/stable).

‎docs/make.jl‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ makedocs(;
1313
),
1414
pages=[
1515
"Home" => "index.md",
16+
"Examples" => "examples.md",
17+
"API" => "api.md",
1618
],
1719
strict=true,
1820
)

‎docs/src/api.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
```@meta
2+
CurrentModule = OMOPCommonDataModel
3+
```
4+
5+
# API
6+
7+
```@index
8+
```
9+
10+
```@autodocs
11+
Modules = [OMOPCommonDataModel]
12+
```

‎docs/src/examples.md‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
```@meta
2+
CurrentModule = OMOPCommonDataModel
3+
```
4+
5+
# Examples
6+
7+
```jldoctest
8+
julia> using OMOPCommonDataModel
9+
10+
julia> using PrettyPrint
11+
12+
julia> using StructArrays
13+
14+
julia> jack = Person(person_id = 1, gender_concept_id = 12, year_of_birth = 1900, race_concept_id = 21, ethnicity_concept_id = 31, gender_source_concept_id = 42, race_source_concept_id = 51, ethnicity_source_concept_id = 61)
15+
Person(1, 12, 1900, missing, missing, missing, missing, 21, 31, missing, missing, missing, missing, missing, 42, missing, 51, missing, 61)
16+
17+
julia> jill = Person(person_id = 2, gender_concept_id = 11, year_of_birth = 1900, month_of_birth = 1, day_of_birth = 1, race_concept_id = 22, ethnicity_concept_id = 32, gender_source_concept_id = 41, race_source_concept_id = 52, ethnicity_source_concept_id = 62)
18+
Person(2, 11, 1900, 1, 1, missing, missing, 22, 32, missing, missing, missing, missing, missing, 41, missing, 52, missing, 62)
19+
20+
julia> pprint(jack)
21+
Person(
22+
person_id=1,
23+
gender_concept_id=12,
24+
year_of_birth=1900,
25+
month_of_birth=missing,
26+
day_of_birth=missing,
27+
birth_datetime=missing,
28+
death_datetime=missing,
29+
race_concept_id=21,
30+
ethnicity_concept_id=31,
31+
location_id=missing,
32+
provider_id=missing,
33+
care_site_id=missing,
34+
person_source_value=missing,
35+
gender_source_value=missing,
36+
gender_source_concept_id=42,
37+
race_source_value=missing,
38+
race_source_concept_id=51,
39+
ethnicity_source_value=missing,
40+
ethnicity_source_concept_id=61,
41+
)
42+
julia> pprint(jill)
43+
Person(
44+
person_id=2,
45+
gender_concept_id=11,
46+
year_of_birth=1900,
47+
month_of_birth=1,
48+
day_of_birth=1,
49+
birth_datetime=missing,
50+
death_datetime=missing,
51+
race_concept_id=22,
52+
ethnicity_concept_id=32,
53+
location_id=missing,
54+
provider_id=missing,
55+
care_site_id=missing,
56+
person_source_value=missing,
57+
gender_source_value=missing,
58+
gender_source_concept_id=41,
59+
race_source_value=missing,
60+
race_source_concept_id=52,
61+
ethnicity_source_value=missing,
62+
ethnicity_source_concept_id=62,
63+
)
64+
julia> person_table = StructArray([jack, jill])
65+
2-element StructArray(::Vector{Int64}, ::Vector{Int64}, ::Vector{Int64}, ::Vector{Union{Missing, Int64}}, ::Vector{Union{Missing, Int64}}, ::Vector{Union{Missing, Dates.DateTime}}, ::Vector{Union{Missing, Dates.DateTime}}, ::Vector{Int64}, ::Vector{Int64}, ::Vector{Union{Missing, Int64}}, ::Vector{Union{Missing, Int64}}, ::Vector{Union{Missing, Int64}}, ::Vector{Union{Missing, String}}, ::Vector{Union{Missing, String}}, ::Vector{Int64}, ::Vector{Union{Missing, String}}, ::Vector{Int64}, ::Vector{Union{Missing, String}}, ::Vector{Int64}) with eltype Person:
66+
Person(1, 12, 1900, missing, missing, missing, missing, 21, 31, missing, missing, missing, missing, missing, 42, missing, 51, missing, 61)
67+
Person(2, 11, 1900, 1, 1, missing, missing, 22, 32, missing, missing, missing, missing, missing, 41, missing, 52, missing, 62)
68+
```

‎docs/src/index.md‎

Lines changed: 5 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -4,73 +4,9 @@ CurrentModule = OMOPCommonDataModel
44

55
# OMOPCommonDataModel
66

7-
Example:
8-
```jldoctest
9-
julia> using OMOPCommonDataModel
7+
The following table maps the version of OMOPCommonDataModel.jl to the
8+
corresponding version of the Common Data Model (CDM).
109

11-
julia> using PrettyPrint
12-
13-
julia> using StructArrays
14-
15-
julia> jack = Person(person_id = 1, gender_concept_id = 12, year_of_birth = 1900, race_concept_id = 21, ethnicity_concept_id = 31, gender_source_concept_id = 42, race_source_concept_id = 51, ethnicity_source_concept_id = 61)
16-
Person(1, 12, 1900, missing, missing, missing, missing, 21, 31, missing, missing, missing, missing, missing, 42, missing, 51, missing, 61)
17-
18-
julia> jill = Person(person_id = 2, gender_concept_id = 11, year_of_birth = 1900, month_of_birth = 1, day_of_birth = 1, race_concept_id = 22, ethnicity_concept_id = 32, gender_source_concept_id = 41, race_source_concept_id = 52, ethnicity_source_concept_id = 62)
19-
Person(2, 11, 1900, 1, 1, missing, missing, 22, 32, missing, missing, missing, missing, missing, 41, missing, 52, missing, 62)
20-
21-
julia> pprint(jack)
22-
Person(
23-
person_id=1,
24-
gender_concept_id=12,
25-
year_of_birth=1900,
26-
month_of_birth=missing,
27-
day_of_birth=missing,
28-
birth_datetime=missing,
29-
death_datetime=missing,
30-
race_concept_id=21,
31-
ethnicity_concept_id=31,
32-
location_id=missing,
33-
provider_id=missing,
34-
care_site_id=missing,
35-
person_source_value=missing,
36-
gender_source_value=missing,
37-
gender_source_concept_id=42,
38-
race_source_value=missing,
39-
race_source_concept_id=51,
40-
ethnicity_source_value=missing,
41-
ethnicity_source_concept_id=61,
42-
)
43-
julia> pprint(jill)
44-
Person(
45-
person_id=2,
46-
gender_concept_id=11,
47-
year_of_birth=1900,
48-
month_of_birth=1,
49-
day_of_birth=1,
50-
birth_datetime=missing,
51-
death_datetime=missing,
52-
race_concept_id=22,
53-
ethnicity_concept_id=32,
54-
location_id=missing,
55-
provider_id=missing,
56-
care_site_id=missing,
57-
person_source_value=missing,
58-
gender_source_value=missing,
59-
gender_source_concept_id=41,
60-
race_source_value=missing,
61-
race_source_concept_id=52,
62-
ethnicity_source_value=missing,
63-
ethnicity_source_concept_id=62,
64-
)
65-
julia> person_table = StructArray([jack, jill])
66-
2-element StructArray(::Vector{Int64}, ::Vector{Int64}, ::Vector{Int64}, ::Vector{Union{Missing, Int64}}, ::Vector{Union{Missing, Int64}}, ::Vector{Union{Missing, Dates.DateTime}}, ::Vector{Union{Missing, Dates.DateTime}}, ::Vector{Int64}, ::Vector{Int64}, ::Vector{Union{Missing, Int64}}, ::Vector{Union{Missing, Int64}}, ::Vector{Union{Missing, Int64}}, ::Vector{Union{Missing, String}}, ::Vector{Union{Missing, String}}, ::Vector{Int64}, ::Vector{Union{Missing, String}}, ::Vector{Int64}, ::Vector{Union{Missing, String}}, ::Vector{Int64}) with eltype Person:
67-
Person(1, 12, 1900, missing, missing, missing, missing, 21, 31, missing, missing, missing, missing, missing, 42, missing, 51, missing, 61)
68-
Person(2, 11, 1900, 1, 1, missing, missing, 22, 32, missing, missing, missing, missing, missing, 41, missing, 52, missing, 62)
69-
```
70-
71-
```@index
72-
```
73-
74-
```@autodocs
75-
Modules = [OMOPCommonDataModel]
76-
```
10+
| OMOPCommonDataModel.jl | CDM |
11+
| ---------------------- | ------ |
12+
| 0.1.0 | 6.0.0 |

0 commit comments

Comments
 (0)