-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdata_dictionary.R
2572 lines (2126 loc) · 91.7 KB
/
data_dictionary.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# ------------------#
# Create Dictionary #
# ------------------#
library(kableExtra)
library(tidyverse)
# #tables in the .xml of the db diagram
# fields_by_table<-split(full_table, full_table$Table_Name)
# Example entries
data_dictionary<-vector(mode = "list")
#Project Table
data_dictionary[["Project_Table"]]<-
list(
data.frame(
Variable="ProjectID",
Label="Project Identifier",
Definition="System-provided Project identifier",
Type="Integer",
Mandatory="System-assigned"),
data.frame(
Variable="ProjectName",
Label="Project Name",
Definition="User-given Project name",
Type="String",
Mandatory="Yes"),
data.frame(
Variable="ProjectCrossReferenceID",
Label="Project Cross Reference Identifier",
Definition="The identifier of the Project under another nomenclature system.
For example, in a different database or document where other identification
for the same Project is used",
Type="String",
Mandatory="No"),
data.frame(
Variable="ProjectCrossReferenceIDOrigin",
Label="Project Cross Reference Identifier Origin",
Definition="The location/database/document where other identification
for the same Project is used",
Type="String",
Mandatory="No"),
data.frame(
Variable="ProjectCountry",
Label="Project Countries",
Definition="The countries where the Project takes place",
Type="Multiple selection",
Mandatory="Yes. Provide at least one option"),
data.frame(
Variable="ProjectFunderOrganization",
Label="Project Funder Organization",
Definition="The organizations providing the funding to conduct the Project",
Type="Multiple selection",
Mandatory="Yes. Provide at least one option"),
data.frame(
Variable="ProjectLeadingOrganization",
Label="Project Leading Organization",
Definition="The organization/institution leading the Project execution",
Type="Single selection",
Mandatory="Yes. Provide at least one option"),
data.frame(
Variable="ProjectLeader",
Label="Project Leader",
Definition="The person leading the Project. Usually affiliated to the Leading Organization",
Type="Single selection",
Mandatory="Yes"),
data.frame(
Variable="ProjectOtherOrganization",
Label="Other Organizations",
Definition="Other organizations/partners/institutions involved in the execution of
the Project (e.g., Laboratories, NGOs, etc.)",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="ProjectPurpose",
Label="Project Purpose",
Definition="Description of the objectives and goals of the Project",
Type="String",
Mandatory="Yes"),
data.frame(
Variable="ProjectNewSourceData",
Label="New Source Data",
Definition="Answer to the question: 'Does the Project involve collecting new data from Sources?'
The answer is 'No' if the Project is using Source or Specimen data already available and generated as
part of a different Project. The answer is 'Yes' when the Project involves collecting new data
from Sources exclusively or when the Project involves the collection of new data and also the use of data from previous Projects)",
Type="Boolean",
Mandatory="Yes"),
data.frame(
Variable="ProjectAnimalSourceSpecies",
Label="Animal Source Species",
Definition="Species of the animals of interest for the Project as Animal Sources. It is possible
to select high taxonomy levels such as 'mammals', 'chordata', 'Insecta', etc. to indicate that
no particular species is targeted",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="ProjectObservationSource",
Label="Observation Source Species",
Definition="Species of the animals of interest for the Project as Observation Sources.
It is possible to select high taxonomy levels such as 'mammals', 'chordata', 'Insecta' etc. to
indicate that no particular species is targeted",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="ProjectEnvironmentalSource",
Label="Environmental Source Types",
Definition="The type(s) of Environmental Source(s) of interest for the Project",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="ProjectInvertebrateSource",
Label="Invertebrate Source Species",
Definition="Species of invertebrate that cause or transmit diseases collected 'off-host' that
are of interest for the Project as Invertebrate Sources. It is possible to select high taxonomy
levels such as 'Diptera', 'Insecta', etc. to indicate that no particular species is targeted",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=ProjectBiologicalHazard",
Label="Biological Hazards",
Definition="The type(s) of biological health hazard(s) of interest for the Project
(e.g., 'Virus', 'Bacteria', 'Protozoa', 'Insecta')",
Type="Multiple selection",
Mandatory="No"),
# ------- Biological Hazard Types
data.frame(
Variable="=ProjectVirusHazard",
Label="Virus",
Definition="The viruses of interest for the Project. It can be as specific as a clade/variant/etc of a species
or as general as 'Virus' (e.g., 'Virus', 'SARS-CoV-2 Omicron variant', 'H5N1 Highly Pathogenic Avian Influenza clade 2.3.3.4b')",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=ProjectBacteriaHazard",
Label="Bacteria",
Definition="The bacteria of interest for the Project. It can be as specific as a strain/serovar/etc of a species
or as general as 'Bacteria' (e.g., 'Group-A Streptococcus', 'Mycobacterium bovis')",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=ProjectProtozoaHazard",
Label="Protozoa",
Definition="The protozoa of interest for the Project. It can be as specific as a strain/serovar/etc of a species
or as general as 'Protozoa' (e.g., 'Plasmodium relictum', 'Toxoplasma gondii')",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=ProjectFungiHazard",
Label="Fungi",
Definition="The fungi of interest for the Project. It can be as specific as a strain/serovar/etc of a species
or as general as 'Fungi' (e.g., 'Pseudogymnoascus destructans', 'Batrachochytrium dendrobatidis')",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=ProjectPrionHazard",
Label="Prion",
Definition="The prion of interest for the Project. It can be as specific as the protein subtype
or as general as 'Prion' (e.g., 'Chronic-wasting disease', 'Scrapie', 'Mad cow disease)", # name of the protein not the disease. REplace
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=ProjectTransmissibleTumourHazard",
Label="Transmissible Tumour",
Definition="The transmissible tumour of interest for the Project (e.g., 'Devil facial tumor 1', 'Devil facial tumor 2')",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=ProjectNematodaHazard",
Label="",
Definition="The nematode of interest for the Project. It can be as specific as a strain/serovar/etc of a species
or as general as 'Nematode' (e.g., 'Toxocara canis', '')",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=ProjectPlatyhelminthHazard",
Label="Platyhelminth",
Definition="The platyhelminth of interest for the Project. It can be as specific as a subspecies
or as general as 'Platyhelminth' (e.g., 'Fasciola gigantica')",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=ProjectArthropodHazard",
Label="Arthropod",
Definition="The arthropod of interest for the Project. It can be as specific as a subspecies
or as general as 'Arthropod' (e.g., 'Sarcoptes scabiei', 'Rhipicephalus sanguineus')",
Type="Multiple selection",
Mandatory="No"),
# --------------------------------
data.frame(
Variable="=ProjectChemicalHazard",
Label="Chemical Hazards",
Definition="The type(s) of chemical health hazard(s) of interest for the Project
(e.g., 'Heavy Metal', 'Organochlorine Pesticides', 'Cholinesterase-inhibbiting Pesticide', 'Toxins')",
Type="Multiple selection",
Mandatory="No"),
# ------- Chemical Hazard Types
data.frame(
Variable="=ProjectHeavyMetalHazard",
Label="Heavy Metal",
Definition="The heavy metal of interest for the Project. It can be as specific as a chemical form of the heavy metal
or as general as the common name of the metal (e.g., 'Lead', 'Methylmercury')",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=ProjectOrganochlorinePesticidesHazard",
Label="Organochlorine Pesticides",
Definition="The organochlorine pesticides of interest for the Project. It can be as specific as a type of organochlorine pesticides
or as general as 'Organochlorine Pesticide' (e.g., 'DDT', 'Lindane')",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=ProjectCholinesteraseInhibbitingPesticideHazard",
Label="Cholinesterase-inhibbiting Pesticide",
Definition="The cholinesterase-inhibbiting pesticide of interest for the Project. It can be as specific as a type of
cholinesterase-inhibbiting pesticide or as general as 'Cholinesterase-inhibbiting Pesticide'
(e.g., 'Diazinon', 'Malathion')",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=ProjectToxinsHazard",
Label="Toxins",
Definition="The toxin of interest for the Project. It can be as specific as the protein subtype
or as general as 'Toxin' (e.g., 'Clostridium botulinum toxin type C', 'Tetanus toxin')", # name of the protein not the disease. REplace
Type="Multiple selection",
Mandatory="No"),
# --------------------------------
data.frame(
Variable="=ProjectPhysicalHazard",
Label="Physical Hazards",
Definition="The type(s) of physical health hazard(s) of interest for the Project
(e.g., 'Trap', 'Vehicle Collisions', 'Entanglement', 'Burning', 'Electrocution')",
Type="Multiple selection",
Mandatory="No"),
# --------------------------------
data.frame(
Variable="=ProjectPhysiologicalHazard",
Label="Physiological Hazards",
Definition="The type(s) of physiological health problems of interest for the Project
(e.g., 'Hypocalcemia', 'Hyperkalemia', 'Amyloid A amyloidosis')",
Type="Multiple selection",
Mandatory="No"),
# --------------------------------
data.frame(
Variable="ProjectStartDate",
Label="Project Start Date",
Definition="The starting date of the Project" ,
Type="Date",
Mandatory="Yes"),
data.frame(
Variable="ProjectEndDate",
Label="Project End Date",
Definition="The date when the Project is projected/planned to end or officially ended",
Type="Date",
Mandatory="No"),
data.frame(
Variable="ProjectUrl",
Label="Project URLs",
Definition="URLs of the Project or of the organizations/institutions involved in the Project",
Type="String",
Mandatory="No"))
# @@@@@@@@@@@@@@@@@@@@@@@@@@@@ #
# Surveillance Objective table #
# @@@@@@@@@@@@@@@@@@@@@@@@@@@@ #
data_dictionary[["Surveillance_Objective"]]<-
list(
data.frame(
Variable="Project Name",
Label="Project Name",
Definition="The name of the Project containing the Surveillance Activity",
Type="Single selection",
Mandatory="Yes"),
data.frame(
Variable="WildlifeHealth_SurveillanceActivityID",
Label="Surveillance Activity Identifier",
Definition="System-provided Surveillance Activity identifier",
Type="Integer",
Mandatory="System-assigned"),
data.frame(
Variable="SurveillanceObjectiveCode",
Label="Surveillance Activity Code",
Definition="User-provided Surveillance Activity code name",
Type="String",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityCrossID",
Label="Surveillance Activity Cross Identifier",
Definition="The identifier of the Surveillance Activity under another nomenclature system.
For example, in a different database or document where other identification
for the same Surveillance Activity is used",
Type="String",
Mandatory="No"),
data.frame(
Variable="SurveillanceActivityCrossReferenceIDOrigin",
Label="SurveillanceActivity Cross Reference Identifier Origin",
Definition="The location/database/document where other identification
for the same Surveillance Activity is used",
Type="String",
Mandatory="No"),
data.frame(
Variable="TypeSurveillanceActivity",
Label="Type of Surveillance Activity",
Definition="The type of surveillance associated with the Surveillance Activity
(e.g., Targeted, Scanning, Outbreak Investigation, or Research). If two or more
surveillance types are involved, then two or more Surveillance Activities are needed
so each one receives a single type of surveillance",
Type="Single selection",
Mandatory="Yes"),
data.frame(
Variable="GrantName",
Label="Grant Name",
Definition="The name of the grant funding the Surveillance Activity. If there is not a
grant involved, type 'N/A'",
Type="String",
Mandatory="Yes"),
data.frame(
Variable="GrantNumber",
Label="Grant Number",
Definition="The number of the grant funding the Surveillance Activity",
Type="String",
Mandatory="No"),
data.frame(
Variable="SurveillanceActivityLeader",
Label="Surveillance Activity Leader",
Definition="The person leading the Surveillance Activity",
Type="Single selection",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityLeaderOrganization",
Label="Leader Organization",
Definition="The affiliation of the person leading the Surveillance Activity",
Type="Single selection",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityLeaderOrganizationROR",
Label="Leader Organization ROR",
Definition="The ROR of the affiliation of the person leading the Surveillance Activity",
Type="String",
Mandatory="No"),
data.frame(
Variable="SurveillanceActivityOrganizationsInvolved",
Label="Organizations Involved",
Definition="Organizations/partners/institutions involved in the execution of
the Surveillance Activity (e.g., Laboratories, NGOs, etc.)",
Type="Multiple selection",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityCountry",
Label="Country or Countries Included in the Surveillance Activity",
Definition="The countries where the Surveillance Activity takes place",
Type="Multiple selection",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityPurpose",
Label="Surveillance Activity Purpose",
Definition="Description of the objectives and goals of the Surveillance Activity",
Type="String",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityDataCurator",
Label="Surveillance Activity Data Curator",
Definition="The person taking responsibility for the entering and cleaning of the
Surveillance Activity data",
Type="Single selection",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityDataOwner",
Label="Surveillance Activity Data Owner",
Definition="The person or institution that owns the data of the Surveillance Activity",
Type="String",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityOtherIndividuals",
Label="Other Individuals",
Definition="Other individuals relevant for the Surveillance Activity, such as laboratory
point of contacts, local leaders, etc.",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="SurveillanceActivityNewSourceData",
Label="New Source Data",
Definition="Answer to the question: 'Does the Surveillance Activity involve collecting new data from Sources?'
The answer is 'No' if the Surveillance Activity is using Source or Specimen data already available and generated as
part of a different Surveillance Activity. The answer is 'Yes' when the Surveillance Activity involves collecting new data
from Sources exclusively or when the Surveillance Activity involves the collection of new data and also the use of data from
previous Surveillance Activity)",
Type="Boolean",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityObservationsIncluded",
Label="Surveillance Activity Includes Observed-only Animals",
Definition="Answer to the question: 'Does the Surveillance Activity include information of observed-only animals'",
Type="Boolean",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityAnimalSourcesIncluded",
Label="Surveillance Activity Includes Animal Sources",
Definition="Answer to the question: 'Does the Surveillance Activity include information of individual animals?'",
Type="Boolean",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityEnvironmentalSourcesIncluded",
Label="Surveillance Activity includes Environmental Sources",
Definition="Answer to the question: 'Does the Surveillance Activity include information of Environmental Sources (e.g., water)?'",
Type="Boolean",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityInvertebrateSourcesIncluded",
Label="Surveillance Activity Includes Invertebrate Sources",
Definition="Answer to the question: 'Does the surveillance objective include information from Invertebrate sources (e.g., CO2 traps)?'",
Type="Boolean",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityNewObservationRecordsAdded",
Label="New Observations Records",
Definition="Answer to the question: 'Does the Surveillance Activity involve the documentation of new
Observation Records?'",
Type="Boolean",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityNewAnimalSourceRecordsAdded",
Label="New Animal Source Records",
Definition="Answer to the question: 'Does the Surveillance Activity involve the documentation of new
Animal Source Records?'",
Type="Boolean",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityNewEnvironmentalSourceRecordsAdded",
Label="New Environmental Source Records",
Definition="Answer to the question: 'Does the Surveillance Activity include the documentation of new
Environmental Source Records (e.g., water)?'",
Type="Boolean",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityNewInvertebrateSourceRecordsAdded",
Label="New Invertebrate Source Records",
Definition="Answer to the question: 'Does the Surveillance Activity include the documentation of new
Invertebrate Source Records (e.g., new invertebrate collection)?'",
Type="Boolean",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivitySpecimens",
Label="New Specimens",
Definition="Answer to the question: 'Are new Specimens collected under the Surveillance Activity?",
Type="Boolean",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityNewDiagnositcProducts",
Label="New Diagnostic Products",
Definition="Answer to the question: 'Does the Surveillance Activity creates new diagnostic products?",
Type="Boolean",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityNewPooledSpecimens",
Label="New Pooled Specimens",
Definition="Answer to the question: 'Does the Surveillance Activity creates new pooled specimens?",
Type="Boolean",
Mandatory="Yes"),
data.frame(
Variable="=SurveillanceActivityBiologicalHazard",
Label="Biological Hazards",
Definition="The type(s) of biological health hazard(s) of interest for the Surveillance Activity
(e.g., 'Virus', 'Bacteria', 'Protozoa', 'Insecta')",
Type="Multiple selection",
Mandatory="No"),
# ------- Biological Hazard Types
data.frame(
Variable="=SurveillanceActivityVirusHazard",
Label="Virus",
Definition="The viruses of interest for the Surveillance Activity. It can be as specific as a clade/variant/etc of a species
or as general as 'Virus' (e.g., 'Virus', 'SARS-CoV-2 Omicron variant', 'H5N1 Highly Pathogenic Avian Influenza clade 2.3.3.4b')",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=SurveillanceActivityBacteriaHazard",
Label="Bacteria",
Definition="The bacteria of interest for the Project. It can be as specific as a strain/serovar/etc of a species
or as general as 'Bacteria' (e.g., 'Group-A Streptococcus', 'Mycobacterium bovis')",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=SurveillanceActivityProtozoaHazard",
Label="Protozoa",
Definition="The protozoa of interest for the Surveillance Activity. It can be as specific as a strain/serovar/etc of a species
or as general as 'Protozoa' (e.g., 'Plasmodium relictum', 'Toxoplasma gondii')",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=SurveillanceActivityFungiHazard",
Label="Fungi",
Definition="The fungi of interest for the Surveillance Activity. It can be as specific as a strain/serovar/etc of a species
or as general as 'Fungi' (e.g., 'Pseudogymnoascus destructans', 'Batrachochytrium dendrobatidis')",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=SurveillanceActivityPrionHazard",
Label="Prion",
Definition="The prion of interest for the Project. It can be as specific as the protein subtype
or as general as 'Prion' (e.g., 'Chronic-wasting disease', 'Scrapie', 'Mad cow disease)", # name of the protein not the disease. REplace
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=SurveillanceActivityTransmissibleTumourHazard",
Label="Transmissible Tumour",
Definition="The transmissible tumour of interest for the Surveillance Activity (e.g., 'Devil facial tumor 1', 'Devil facial tumor 2')",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=SurveillanceActivityNematodaHazard",
Label="",
Definition="The nematode of interest for the Surveillance Activity. It can be as specific as a strain/serovar/etc of a species
or as general as 'Nematode' (e.g., 'Toxocara canis', '')",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=SurveillanceActivityPlatyhelminthHazard",
Label="Platyhelminth",
Definition="The platyhelminth of interest for the Surveillance Activity. It can be as specific as a subspecies
or as general as 'Platyhelminth' (e.g., 'Fasciola gigantica')",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=SurveillanceActivityArthropodHazard",
Label="Arthropod",
Definition="The arthropod of interest for the Surveillance Activity. It can be as specific as a subspecies
or as general as 'Arthropod' (e.g., 'Sarcoptes scabiei', 'Rhipicephalus sanguineus')",
Type="Multiple selection",
Mandatory="No"),
# --------------------------------
data.frame(
Variable="=SurveillanceActivityChemicalHazard",
Label="Chemical Hazards",
Definition="The type(s) of chemical health hazard(s) of interest for the Surveillance Activity
(e.g., 'Heavy Metal', 'Organochlorine Pesticides', 'Cholinesterase-inhibbiting Pesticide', 'Toxins')",
Type="Multiple selection",
Mandatory="No"),
# ------- Chemical Hazard Types
data.frame(
Variable="=SurveillanceActivityHeavyMetalHazard",
Label="Heavy Metal",
Definition="The heavy metal of interest for the Surveillance Activity. It can be as specific as a chemical form of the heavy metal
or as general as the common name of the metal (e.g., 'Lead', 'Methylmercury')",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=SurveillanceActivityOrganochlorinePesticidesHazard",
Label="Organochlorine Pesticides",
Definition="The organochlorine pesticides of interest for the Surveillance Activity. It can be as specific as a type of organochlorine pesticides
or as general as 'Organochlorine Pesticide' (e.g., 'DDT', 'Lindane')",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=SurveillanceActivityCholinesteraseInhibbitingPesticideHazard",
Label="Cholinesterase-inhibbiting Pesticide",
Definition="The cholinesterase-inhibbiting pesticide of interest for the Surveillance Activity. It can be as specific as a type of
cholinesterase-inhibbiting pesticide or as general as 'Cholinesterase-inhibbiting Pesticide'
(e.g., 'Diazinon', 'Malathion')",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="=SurveillanceActivityToxinsHazard",
Label="Toxins",
Definition="The toxin of interest for the Surveillance Activity. It can be as specific as the protein subtype
or as general as 'Toxin' (e.g., 'Clostridium botulinum toxin type C', 'Tetanus toxin')", # name of the protein not the disease. REplace
Type="Multiple selection",
Mandatory="No"),
# --------------------------------
data.frame(
Variable="=SurveillanceActivityPhysicalHazard",
Label="Physical Hazards",
Definition="The type(s) of physical health hazard(s) of interest for the Surveillance Activity
(e.g., 'Trap', 'Vehicle Collisions', 'Entanglement', 'Burning', 'Electrocution')",
Type="Multiple selection",
Mandatory="No"),
# --------------------------------
data.frame(
Variable="=SurveillanceActivityPhysiologicalHazard",
Label="Physiological Hazards",
Definition="The type(s) of physiological health problems of interest for the Surveillance Activity
(e.g., 'Hypocalcemia', 'Hyperkalemia', 'Amyloid A amyloidosis')",
Type="Multiple selection",
Mandatory="No"),
# --------------------------------
data.frame(
Variable="SurveillanceActivityIACUCNeeded",
Label="IACUC Needed",
Definition="Answer to the question: 'Is an IACUC needed to conduct the Surveillance Activity?'",
Type="Boolean",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityOrganizationProvidingIACUC",
Label="Organization providing IACUC",
Definition="The organization providing the IACUC approving the methodology of the Surveillance Activity",
Type="String",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityIACUCCode",
Label="IACUC Code",
Definition="The code of the IACUC approving the methodology of the Surveillance Activity",
Type="String",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityLocationPolygonUnitOfInterest",
Label="Location Polygon Is a Unit of Interest",
Definition="Answer to the question: 'Is the Location a Polygon that represents a unit of interest for the Surveillance Activity
(e.g., a parcel or a house)?'" ,
Type="Boolean",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityLocationPolygonRepresents",
Label="Location Polygon Description",
Definition="A description of what each polygon Location represents in the Surveillance Activity (e.g., a parcel or a house)" ,
Type="String",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityLocationSpatialFileProvided",
Label="Spatial File with Location Polygons Provided",
Definition="'Answer to the question: 'Are the Location polygons included in the
Surveillance Activity provided as a spatial file (.shp, .geojson, other)?'" ,
Type="Boolean",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityLocationPolygonProjection",
Label="Spatial Projection Of Location Polygons In Spatial File",
Definition="Answer to the question: 'Is the spatial projection of the Location Polygons file provided as a spatial file?'" ,
Type="String",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityEventUnitOfInterest",
Label="The Event Is a Unit of Interest",
Definition="Answer to the question: 'Is the Event (and its associated longitude, latitude, and time)
a unit of interest for the Surveillance Activity?'" ,
Type="Boolean",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityEventRepresents",
Label="Event Description",
Definition="A description of what each Event represents in the Surveillance Activity
(e.g., a trap, a stall, the location of a health event, etc.)" ,
Type="String",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityEventGrouping",
Label="Events Are Grouped",
Definition="Answer to the question: 'Are Events associated with the current
Surveillance Activity clustered in units smaller than 'Location'?'",
Type="Boolean",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityEventGroupingStructure",
Label="Grouping of Events",
Definition="Explain the grouping structure of the Events below 'location'
(e.g., The location is a market. The events are stalls of each vendor in the market.
The Events are grouped by vendor in each market. So stalls [events],
within vendors [group], within markets [location])",
Type="String",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityEventGroupsSpatialFileProvided",
Label="Event Groups File Provided",
Definition="'Answer to the question: 'Are the Event groups provided as a spatial file (.shp, .geojson, other)?'" ,
Type="Boolean",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityEventGroupsProjection",
Label="Spatial Projection of Event Groups Spatial File",
Definition="The spatial projection of Event groups file provided as a spatial file" ,
Type="String",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivitySourceRecordGrouping",
Label="Source Records Are Grouped",
Definition="Answer to the question: 'Are Source Records associated with the current
Surveillance Activity clustered in units smaller than 'Event'?'",
Type="Boolean",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivitySourceRecordGroupingStructure",
Label="Grouping of Source Records",
Definition="Explain the grouping structure of the Source Records below 'Event'
(e.g., Events represent a stall in a market. Source records (animals in the stall)
are grouped by cage in each stall)",
Type="String",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityLab",
Label="Participating Laboratories",
Definition="The laboratories associated with the Surveillance Activity",
Type="Multiple selection",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityOtherSurveillanceActivityAssociated",
Label="Other Surveillance Activities or Datasets Associated",
Definition="Answer to the question: 'Are there other Surveillance Activities
associated with the current Surveillance Activity or other datasets?'
(e.g., if the current Surveillance Activity uses Specimens collected as part of
other associated Surveillance Objective, or if the full set of events of a ranger
patrol (beyond health events) belong to the patrol XXXX of the protected
area Y')",
Type="Boolean",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityOtherSurveillanceActivityAssociatedCode",
Label="Associated Surveillance Activities Codes",
Definition="Describe why other Surveillance Activities are associated with the
current Surveillance Activity (e.g., the current Surveillance Activity uses
Specimens collected as part of Surveillance Objective ZZZZ, or the health Events
are part of patrols conducted in protected YYY'. The patrol ID including
the Events of the current Surveillance Activity are given in the Field Visit
Cross Reference Identifier)",
Type="Multiple selection",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityReasonOtherSurveillanceActivityAssociated",
Label="Reason other Surveillance Activities or Datasets Are Associated",
Definition="Describe why other Surveillance Activities are associated with the
current Surveillance Activity (e.g., the current Surveillance Activity uses
Specimens collected as part of Surveillance Objective ZZZZ, or the health Events
are part of patrols conducted in protected YYY'. The patrol ID including
the Events of the current Surveillance Activity are given in the Field Visit
Cross Reference Identifier)",
Type="String",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityRelevantUrl",
Label="Surveillance Activity URLs",
Definition="URLs of the Surveillance Activity, associated with the Surveillance
Activity, or organizations leading the Surveillance Activity",
Type="String",
Mandatory="No"),
data.frame(
Variable="SurveillanceActivityPublication",
Label="Surveillance Activity Publications",
Definition="Publication references associated with the Surveillance Activity",
Type="String",
Mandatory="No"),
data.frame(
Variable="SurveillanceActivityStartDate",
Label="Surveillance Activity Start Date",
Definition="The date the Surveillance Objective officially started" ,
Type="Date",
Mandatory="Yes"),
data.frame(
Variable="SurveillanceActivityEndDate",
Label="Surveillance Activity End Date",
Definition="The date the Surveillance Activity is projected to end or officially ended",
Type="Date",
Mandatory="No"))
#Outbreak
data_dictionary[["Outbreak"]]<-
list(
data.frame(
Variable="OutbreakName",
Label="Outbreak name",
Definition="The name provided to the outbreak",
Type="String",
Mandatory="Yes, if the surveillance objective type is 'Outbreak'"),
data.frame(
Variable="OutbreakDiagnosis",
Label="Outbreak Diagnosis",
Definition="The diagnosis provided to the outbreak",
Type="String",
Mandatory="No"))
data.frame(
Variable="SurveillanceActivityObservationSource",
Label="Observation Source Species",
Definition="Species of the animals of interest for the Project as Observation Sources.
It is possible to select high taxonomy levels such as 'mammals', 'chordata', 'Insecta' etc. to
indicate that no particular species is targeted",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="SurveillanceActivityEnvironmentalSource",
Label="Environmental Source Types",
Definition="The type(s) of Environmental Source(s) of interest for the Project",
Type="Multiple selection",
Mandatory="No"),
data.frame(
Variable="SurveillanceActivityInvertebrateSource",
Label="Invertebrate Source Species",
Definition="Species of invertebrate that cause or transmit diseases collected 'off-host' that
are of interest for the Project as Invertebrate Sources. It is possible to select high taxonomy
levels such as 'Diptera', 'Insecta', etc. to indicate that no particular species is targeted",
Type="Multiple selection",
Mandatory="No"),
#Field Activity
data_dictionary[["Field_Activity"]]<-
list(
data.frame(
Variable="WildlifeHealth_FieldActivityID",
Label="Field activity identifier",
Definition="System-provided field activity identifier",
Type="Integer",
Mandatory="System-assigned"),
data.frame(
Variable="FieldActivityCode",
Label="Field activity code",
Definition="User-provided field activity code",
Type="String",
Mandatory="Yes"),
data.frame(
Variable="FieldActivityCrossID",
Label="Field Activity Cross Identifier",
Definition="The identifier of the field activity under another nomenclature system",
Type="String",
Mandatory="No"),
data.frame(
Variable="WildlifeHealth_FieldActivityLeaderName",
Label="Field activity leader name",
Definition="The leader of the field activity of the surveillance project",
Type="Single selection",
Mandatory="Yes"),
data.frame(
Variable="WildlifeHealth_FieldActivityType",
Label="Field activity type",
Definition="The type of field activity (e.g., 'Market', 'Free-ranging', 'Ranger patroling')",
Type="Multiple selection",
Mandatory="Yes"),
data.frame(
Variable="FieldActivityHistory",
Label="Field activity history",
Definition="The background of the field activity (e.g., why, who, how, where, what for)" ,
Type="String",
Mandatory="Yes"),