eDataDRF/_pkgdown.yml at main · NIVANorge/eDataDRF · GitHub

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
url: https://NIVANorge.github.io/eDataDRF/
template:
  bootstrap: 5
  bslib:
    font-size: "0.75rem"
  light-switch: true

navbar:
  structure:
    left: [intro, reference, articles, news]
    right: [search, github, lightswitch]

glossary:
  path: glossary.yml
  popup: hover
  show: true

articles:
- title: "Data tables"
  navbar:
  desc: "Format and variables for each table in the eData DRF"
  contents:
  - campaign_data
  - references_data
  - sites_data
  - parameters_data
  - compartments_data
  - samples_data
  - biota_data
  - methods_data
  - measurements_data

- title: "CREED quality assessment"
  navbar:
  desc: "Format and scoring for data quality assessment"
  contents:
  - CREED_data
  - CREED_scores_data

- title: "Other"
  navbar:
  contents:
  - validation
  - rationale

reference:
- title: Initialise tibbles
  desc:  Create empty versions of the format's tables as R tibble objects
- contents:
  - initialise_campaign_tibble
  - initialise_references_tibble
  - initialise_sites_tibble
  - initialise_parameters_tibble
  - initialise_compartments_tibble
  - initialise_methods_tibble
  - initialise_samples_tibble
  - initialise_biota_tibble
  - initialise_measurements_tibble
  - initialise_CREED_data_tibble
  - initialise_CREED_scores_tibble
- title: Controlled vocabulary
  desc: Vectors (and sometimes tibbles) of controlled vocabulary
- contents:
  - ends_with("_vocabulary")
- contents:
  - ends_with("_limits")
- title: Generate IDs
  desc: Generate ID strings based on abbreviated titles, plus regex to check
- contents:
  - abbreviate_string
  - generate_reference_id
  - generate_protocol_id
  - generate_sample_id_with_components
  - sample_id_regex
  - protocol_id_regex
- title: Export
  desc: Export tables as zipped CSV files
- contents:
  - get_dataset_display_name
  - export_campaign_zip
- title: Example data
  desc: Functions to generate example data
- contents:
  - contains("example_")
  - CREED_tibble_to_mock_input
- title: Validation
  desc: Functions using {pointblank} to validate data
- contents:
  - contains("validate")

deploy:
  install_metadata: true # linking to STOPeData, hopefully