A template for setting up an empirical study utilizing the Boa infrastructure. Using this template provides several benefits:
- Automatic management of Boa scripts and data
- A template system for Boa queries
- A Docker-based environment for people to easily replicate your study
- Automated publishing to Zenodo, including handling of double-blinded submissions
See the online documentation for more details on how to use the study template.
- Requirements
- Performing Research With This Template
- Using a Replication Package Built With This Template
You need a GNU Make compatible build system and Python. See the full requirements for more details.
Note that a username/password to the Boa website and API are required. You can request one here: https://boa.cs.iastate.edu/request/
See the online documentation for Using the Template for more details.
Your replication package will need a README file. We provide a template file,
sample-README.md, that you can use as a starting point
for your package. Just rename the file to README.md and edit accordingly.
There are several places with "TODO" notices that you will definitely want to
change. And we recommend also adding a section at the end that describes each
analysis in a bit more detail.
See the online documentation for Using a Replication for more details.