Data Documentation Template

[kimberly-bastille]

It is important that all data presented using the dashboard is fully documented before being included.

Make RMD template for this documentation including these sections:

• Title
• Description - short description, years of data available
• Data Source - where the data comes from, who collects/owns/maintains
• Data Extraction - How do we access the data
• Data Analysis/Processing - is there any analysis or processing that occurs - links to code that does that

The goal of the template is to standardize how we are including information and ensuring that users interested in diving deeper would know where to go. So links to websites or public code are encouraged.

Is there other information that should be included?

[kimberly-bastille]

Data Documentation template is an RMD that is knitted to HTML and displayed in the documentation tab in the dashboard. The ui pulls HTML from the docs folder and can display them in dashboard.

Maintenance:

1. All files are stored in the docs folder in both RMD and HTML versions.
2. Name of the document should be added to the Documentation Panel section of the UI in app.R.

Ensure that all sections of the documentation are complete before adding to the UI.