bayareametro/dv-project-templates

How to document MTC Data & Visualization projects on GitHub.

dv-project-templates's Issues

document how to deal with linking to data

we need to document how we handle links to data.

e.g.
"if adding links to Box, maybe we would want to make sure we added a blurb/section on:

• who can access the data,
• license

And maybe if it IS private data, some blurb on who to contact either for access or more info?

potential solution, add section to doc on submitting issue with questions re:access and use.

develop list of examples

for example based on this list: https://github.com/showcases/projects-with-great-wikis

develop further templates by project type

for example:

cartographic, web (static), web(framework), data processing, sql

add examples with analysis parameters

none of the examples contain a use of "analysis parameters". @joshuacroff pointed out that it may not self-evident how to populate this section.

it seems like we should use this section more often in our previous examples, and use it more in the future. for example, for the TPA data processing, important analysis parameters might be that 2 transit operators may interpolate stop times differently, or there might be error in encoding any aspect of the scheduling, which affects the end result/desired outcome, even though the thing being measured in those instances is not directly related to the outcome.