Contributing documentation
12
Documenting code
Building tidy R packages for the OMOP common data model
Introduction
Getting started
1
Scope
2
Ecosystem
3
Contributing to a package
4
Set up your environment
Principles
5
Core dependencies
6
Function interfaces
7
Conventions
8
Function outputs
9
Error messages and input validation
10
Styling your code
11
Reexporting from other packages
Contributing documentation
12
Documenting code
13
Documenting functions
14
Readme
15
Vignettes
16
Documentation website
Adding unit tests
17
Unit testing
18
Testing across multiple systems
19
Efficient testing
20
Documenting tests
GitHub
21
Set up GitHub
22
Automatic R-CDM checks
23
Website deployment
24
Test coverage
25
Testing multiple DBMS
Maintaing a package
26
Submit to CRAN
Contributing documentation
12
Documenting code
12
Documenting code
Contributing documentation
13
Documenting functions