From da613d7ee2a616a4630d8a9b186f52e503845d4b Mon Sep 17 00:00:00 2001 From: Nicklas Hafiz Date: Tue, 13 Feb 2024 11:10:55 +0100 Subject: [PATCH 1/2] minor changes to index --- docs/src/index.md | 2 +- src/database.jl | 3 +-- src/taxons/no_taxon.jl | 1 - 3 files changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/src/index.md b/docs/src/index.md index 2fe4171..0ec36f7 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -39,7 +39,7 @@ Besides enabling better simulations, knowing how common different types of SEMs ## Data Base ```@docs -RecordDatabase(records::Record...) +RecordDatabase ``` ## Taxons diff --git a/src/database.jl b/src/database.jl index 5758c5e..49ec951 100644 --- a/src/database.jl +++ b/src/database.jl @@ -12,7 +12,7 @@ end """ - RecordDatabase() + RecordDatabase `Record`s need to be stored somewhere. @@ -36,7 +36,6 @@ RecordDatabase{Base.UUID, Record} with 3 entries: UUID("552ef675-5c7b-4ce1-880b-c45b833fdfcb") => Record… ``` """ - struct RecordDatabase{K<:UUID,V<:Record} <: Base.AbstractDict{K,V} records::Dict{K,V} end diff --git a/src/taxons/no_taxon.jl b/src/taxons/no_taxon.jl index 758ac30..b02e87e 100644 --- a/src/taxons/no_taxon.jl +++ b/src/taxons/no_taxon.jl @@ -26,7 +26,6 @@ NoTaxonYet gives you the option to name the 'modeltype', you were not able to co julia> NoTaxonYet() """ - struct NoTaxonYet <: Taxon accessdate::Date modeltype::Union{String, Missing} From 1b61cad8fdc338aa63978129ed7c0e08c704f2e2 Mon Sep 17 00:00:00 2001 From: Nicklas Hafiz Date: Tue, 13 Feb 2024 12:01:17 +0100 Subject: [PATCH 2/2] minimal recordDatabase example --- src/database.jl | 22 +--------------------- 1 file changed, 1 insertion(+), 21 deletions(-) diff --git a/src/database.jl b/src/database.jl index 49ec951..dfb15bf 100644 --- a/src/database.jl +++ b/src/database.jl @@ -12,29 +12,9 @@ end """ - RecordDatabase +RecordDatabase `Record`s need to be stored somewhere. - -```jldoctest -julias> RecordDatabase() -RecordDatabase{Base.UUID, Record}() - -julia> first = Record(rater = "AP", id = "552ef675-5c7b-4ce1-880b-c45b833fdfcb", location = NoLocation(), meta = MetaData(missing, missing, missing), judgements = Dict("Taxon" => J(NoTaxon())), spec = NoJudgement(), data = NoJudgement()); - -julias> second = Record(rater = "AP", id = "58c55701-0362-40c7-849c-5d12e5026238", location = NoLocation(), meta = MetaData(missing, missing, missing), judgements = Dict("Taxon" => J(NoTaxon())), spec = NoJudgement(), data = NoJudgement()); - -julia> rd = RecordDatabase(first, second) -RecordDatabase{Base.UUID, Record} with 2 entries: - UUID("58c55701-0362-40c7-849c-5d12e5026238") => Record… - UUID("552ef675-5c7b-4ce1-880b-c45b833fdfcb") => Record… - -julias> rd += Record(rater = "AP", id = "2d7ad584-8ec0-47dd-807b-280fba2978f8", location = NoLocation(), meta = MetaData(missing, missing, missing), judgements = Dict("Taxon" => J(NoTaxon())), spec = NoJudgement(), data = NoJudgement()) -RecordDatabase{Base.UUID, Record} with 3 entries: - UUID("2d7ad584-8ec0-47dd-807b-280fba2978f8") => Record… - UUID("58c55701-0362-40c7-849c-5d12e5026238") => Record… - UUID("552ef675-5c7b-4ce1-880b-c45b833fdfcb") => Record… -``` """ struct RecordDatabase{K<:UUID,V<:Record} <: Base.AbstractDict{K,V} records::Dict{K,V}