Session 09 - Best practices in theory formalization; create a new VAST
Groups start working on their own formalization projects, setting up the technical infrastructure and preparing a new repository with best practices.
NoteInstructor notes
- Create the folder
homework/04-Quality_checklistin the homework repo.
Overview
| Topic | Duration | Notes |
|---|---|---|
| Best (technical) practices in theory development: CFF + semver + folder structure | 60 | Lecture IT-Tools Slides |
| Prepare a new repository in each group | 25 | Formalization Steps 1 & 2 |
| Group work: Create your VAST | 120 | Formalization Steps 3 - 6 |
Prepare your own repository
Each group should set up their technical infrastructure - from now on, you start working in your own repository.
- One team member (the “maintainer”) creates a fresh public repository on the Github website.
- Invite the lecturer (user name:
nicebread) and all team members as collaborators on Github: Settings → Collaborators → “Add people”. - All team members clone the repository to their local computers.
- Create a Google doc (or a comparable collaborative document) for the tables, make it publicly readable for anybody.
- Link the Google doc in the README of the repository. Link the repository in the Google doc.
- Prepare the folder structure
- Create your
CITATION.cfffile with the cffinit tool, assign your first version number (presumably:0.1.0).
- Create your
Homework 1
- Finalize Formalization Steps 3 - 6
- Assign a new semantic version number.
- Push everything in your repo
- Follow coding best practices. See for example Readable, Reliable, Reusable: A Guide to Clean R Code
Homework 2
For next week, prepare an(informal) presentation of your VAST:
- Show and guide through your VAST display
- Explain your scope (importantly: What is not included?)
- Explain your robust phenomenon - What is the explanatory target of your theory?
- Open questions / Challenges you encountered