Add DataFrames to the example (#11)

Author: DilumAluthge

Project.toml

@@ -8,16 +8,18 @@ Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
 DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
 
 [compat]
+DataFrames = "0.21"
 DocStringExtensions = "0.8"
 PrettyPrint = "0.1"
 StructArrays = "0.4"
 julia = "1.1"
 
 [extras]
+DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 PrettyPrint = "8162dcfd-2161-5ef2-ae6c-7681170c5f98"
 StructArrays = "09ab397b-f2b6-538f-b94a-2f83cf4a842a"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Documenter", "PrettyPrint", "StructArrays", "Test"]
+test = ["DataFrames", "Documenter", "PrettyPrint", "StructArrays", "Test"]

docs/Project.toml

@@ -1,9 +1,11 @@
 [deps]
+DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 OMOPCommonDataModel = "ba65db9e-6590-4054-ab8a-101ed9124986"
 PrettyPrint = "8162dcfd-2161-5ef2-ae6c-7681170c5f98"
 StructArrays = "09ab397b-f2b6-538f-b94a-2f83cf4a842a"
 
 [compat]
+DataFrames = "0.21"
 PrettyPrint = "0.1"
 StructArrays = "0.4"

docs/src/examples.md

@@ -7,9 +7,7 @@ CurrentModule = OMOPCommonDataModel
 ```jldoctest
 julia> using OMOPCommonDataModel
 
-julia> using PrettyPrint
-
-julia> using StructArrays
+julia> using DataFrames, PrettyPrint, StructArrays
 
 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)
 Person(1, 12, 1900, missing, missing, missing, missing, 21, 31, missing, missing, missing, missing, missing, 42, missing, 51, missing, 61)
@@ -39,6 +37,7 @@ Person(
   ethnicity_source_value=missing,
   ethnicity_source_concept_id=61,
 )
+
 julia> pprint(jill)
 Person(
   person_id=2,
@@ -61,8 +60,19 @@ Person(
   ethnicity_source_value=missing,
   ethnicity_source_concept_id=62,
 )
-julia> person_table = StructArray([jack, jill])
+
+julia> person_table = StructArray(Person[jack, jill])
 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:
  Person(1, 12, 1900, missing, missing, missing, missing, 21, 31, missing, missing, missing, missing, missing, 42, missing, 51, missing, 61)
  Person(2, 11, 1900, 1, 1, missing, missing, 22, 32, missing, missing, missing, missing, missing, 41, missing, 52, missing, 62)
+
+julia> person_table_df = DataFrame(person_table);
+
+julia> @show person_table_df;
+person_table_df = 2×19 DataFrame
+│ Row │ person_id │ gender_concept_id │ year_of_birth │ month_of_birth │ day_of_birth │ birth_datetime │ death_datetime │ race_concept_id │ ethnicity_concept_id │ location_id │ provider_id │ care_site_id │ person_source_value │ gender_source_value │ gender_source_concept_id │ race_source_value │ race_source_concept_id │ ethnicity_source_value │ ethnicity_source_concept_id │
+│     │ Int64     │ Int64             │ Int64         │ Int64?         │ Int64?       │ DateTime…?     │ DateTime…?     │ Int64           │ Int64                │ Int64?      │ Int64?      │ Int64?       │ String?             │ String?             │ Int64                    │ String?           │ Int64                  │ Union{Missing, String} │ Int64                       │
+├─────┼───────────┼───────────────────┼───────────────┼────────────────┼──────────────┼────────────────┼────────────────┼─────────────────┼──────────────────────┼─────────────┼─────────────┼──────────────┼─────────────────────┼─────────────────────┼──────────────────────────┼───────────────────┼────────────────────────┼────────────────────────┼─────────────────────────────┤
+│ 1   │ 1         │ 12                │ 1900          │ missing        │ missing      │ missing        │ missing        │ 21              │ 31                   │ missing     │ missing     │ missing      │ missing             │ missing             │ 42                       │ missing           │ 51                     │ missing                │ 61                          │
+│ 2   │ 2         │ 11                │ 1900          │ 1              │ 1            │ missing        │ missing        │ 22              │ 32                   │ missing     │ missing     │ missing      │ missing             │ missing             │ 41                       │ missing           │ 52                     │ missing                │ 62                          │
 ```

test/runtests.jl

@@ -1,5 +1,6 @@
 using OMOPCommonDataModel
 
+using DataFrames
 using Documenter
 using PrettyPrint
 using StructArrays