opencis/_pkgdown.yml at main · hmeleiro/opencis · 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
url: https://opencis.spainelectoralproject.com/
template:
  package: spainelectoraltheme
  bootstrap: 5
lang: en
navbar:
  structure:
    left:  [intro, reference, articles, news]
    right: [github, twitter, search]
  components:
    github:
      icon: fa-github
      href: https://github.com/hmeleiro/opencis
      aria-label: Github
    twitter:
      icon: fa-twitter
      href: http://twitter.com/hmeleiros
      aria-label: Twitter
repo:
  url:
    home: https://github.com/hmeleiro/opencis
    issue: https://github.com/hmeleiro/opencis/issues
    user: https://github.com/hmeleiro

home:
  links:
    - text: Report a bug
      href: https://github.com/hmeleiro/opencis/issues
  sidebar:
    structure: [links, license, authors, citation, dev]

footer:
  structure:
    left: [developed_by, sep_branding]
    right: [license, built_with]
  components:
    license: >
      Licensed under <a href="https://www.gnu.org/licenses/gpl-3.0" target="_blank" rel="noopener">GPL-3</a>.

reference:
- title: Import data
  desc:  Functions to import CIS study data into R.
  contents:
  - read_cis
  - download_study
  - get_data_dictionary

- title: Search
  desc:  Functions to search for studies, questions and timeseries in the CIS catalog.
  contents:
  - search_cis
  - search_all_cis

- title: Study details
  desc:  Functions to retrieve metadata and documents for a specific study.
  contents:
  - get_metadata
  - browse_pdf

- title: Utilities
  desc:  Helper functions for cache management.
  contents:
  - cache_info
  - clear_cache