R-notebook-templates
This repository contains notebook templates for submission to US-RSE hosted calls for submissions, two broad types of submissions are represented 1) reproducible documents which are defined to be artifacts that are executed sequentially from beginning to end and do not require input or interaction from the user and 2) Interactive Notebooks which are defined by being dependent on, and specifically designed for user input and interaction. For R users, we generally expect the formats for reproducible documents to be Quarto documents or R Markdown documents, whereas interactive notebooks may also take the form of a shiny app. Templates for Quarto documents and Shiny apps may be found in this repository. Templates for python-language submissions may be found at https://github.com/USRSE/jupyter-notebook-templates. Submitters are not required to use the provided templates, but must make sure their submission adheres to the submission requirements. Submitters who feel their work does not fall into either category of reproducible documents or interactive notebooks may choose to submit to a third category called "Innovative Uses of Notebooks". Abstracts accompanying submission for Innovative Uses should entail a justification for why it does not belong in the first two categories and why it should be considered as a "new" submission format.
Submission types
There are three submission categories. General templates are provided for Reproducible documents and Interactive notebooks. Additionally, a template for a reproducible publication falling under the Reprodcible Document category is available.
- Reproducible documents
- includes reproducible publications
- Interactive Notebooks
- includes shiny apps
- Innovative use of Notebooks
To read more about these submission types to decide how your notebook shouls be categorized, see https://us-rse.org/usrse23/participate/notebooks/
Submission Requirements
Notebooks should be submitted as GitHub repositories Your repository should contain the following for favorable review:
- your notebook file
- Environment files (runtime.txt and install.R)
- citation.cff
- README file with the following:
- title
- abstract (word limit: 250)
- for shiny apps: a walkthrough example of how to use your application
- any other supporting files necessary for the notebook to run (including any GitHub-sized static data files)
How to submit on Easy Chair
On easy chair there are three requirements for submission:
- choose your submission type. a) if choosing interactive notebook, additional upload required for usage instructions. What steps should reviewers walk through and what results should they get? To verify "reproducibility" for
- a zipped citation.cff file (consider using the cffinit web tool to easily create this file)
- GitHub link to your public repository (if you cannot submit a public repository, email us).
- the name of branch you want to be reviewed
- Optional - a specific commit you want to be reviewed (Otherwise, we will use the most recent commit before the submission due date. Updates after the deadline will not be considered)