Developer Orientation

Assumptions + prerequisites

• Understand R
• Understand basic statistics, data analysis, and modeling principles
• Understand how to build R packages
• Understand how to use GitHub and TravisCI
• Understand RShiny and shinytest if contributing to the User Interface

Get VisionEval running

• Use the Quick Start guide to download and run an example

Understand the development principles and organization of VisionEval framework

• Review System Design Documentation
• Review Contribution Criteria

Skim useful references to know about

• VE style guide
• GitHub repo processes / branching and versioning plan
• Testing requirements, test data, and running tests
• Developer roadmap
• Organization and naming of packages and modules, see VE Name Registry [ Status: to be developed ]
• Original GREENSTEP documentation
• Organization of data store and test data, see VE Name Registry [ Status: to be developed ]
• List of useful functions in the API for developers [ Status: to be developed; see API for now ]

Go thru relevant Package Development Tutorials

• Vignette for adding a module to existing package [ Status: needs to be developed ]
• Vignette for making changes to existing module [ Status: needs to be developed ]

Understand licensing

• VisionEval uses this LICENSE
• Each package has a DESCRIPTION file and a LICENSE file
• The source files do not contain license and/or copyright information