/
_pkgdown.yml
77 lines (77 loc) · 2.55 KB
/
_pkgdown.yml
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
home:
title: An R Client for the ODK Central API
description: R, you, and ODK - Interact with ODK Central from R
template:
opengraph:
image:
src: man/figures/ruODK2.png
alt: "An R Client for the ODK Central API"
twitter:
creator: "@florianm"
site: "@rOpenSci"
card: summary_large_image
reference:
- title: OData API
desc: >
Top-level functions to retrieve and parse data via the OData API.
These functions alone are enough to retrieve all submissions with their
nested tables and attachments and parse their datatypes.
See `vignette("odata-api")` for a walkthrough.
contents:
- has_concept("odata-api")
- title: Projects
desc: "Functions to manage projects."
contents:
- has_concept("project-management")
- title: Forms
desc: >
Functions to manage forms.
Once their implementation is completed,
these functions can be used to manage the life cycle of forms from drafts
to published forms, their retirement, form permissions, as well as form
attachments.
contents:
- has_concept("form-management")
- title: Submissions
desc: >
Functions to manage submissions and their attachments.
This family of functions provides an alternative way to the OData family.
Specifically, submissions include nested tables in each record.
See `vignette("restful-api")` for a walkthrough.
contents:
- has_concept("submission-management")
- title: Users
desc: "Functions to operate on users, roles, and their permissions."
contents:
- has_concept("user-management")
- title: Server
desc: "Functions related to server management."
contents:
- has_concept("server-management")
- title: Utilities
desc: >
Functions to assist with retrieval and parsing of submissions and their
attachments. These functions are used from within top-level functions.
The typical workflow does not call these explicitly.
contents:
- has_concept("utilities")
- title: Messaging
desc: "Custom handlers for messages, warnings, and errors."
contents:
- has_concept("messaging")
- title: Settings
desc: "Functions to manage ruODK settings."
contents:
- has_concept("ru_settings")
- title: Example data
desc: >
Datasets included in ruODK, used in unit tests, code examples and vignettes.
contents:
- has_concept("included")
authors:
DBCA:
html: "<img src='man/figures/dbca_bcs.png' width='150' alt='DBCA'/>"
href: https://www.dbca.wa.gov.au/science/
NWSFTCP:
html: "<img src='man/figures/flatbacks.svg' width='150' alt='NWSFTCP'/>"
href: https://flatbacks.dbca.wa.gov.au/