Skip to content

nicebread/FOMO-Psy

Repository files navigation

DOI

Course material for "Introduction to Formal modeling in Psychology" (FOMO-Psy)

This is the source code of the Quarto website. See the rendered website at https://nicebread.github.io/FOMO-Psy/.

Note: While most content is in English, some administrative parts are in German.

Compilation / dependencies

You need:

Run the following commands in the project's root directory:

quarto add quarto-ext/attribution
quarto add quarto-ext/fontawesome
quarto install extension nicebread/quarto-FS

quarto update extension nicebread/quarto-FS

Notes to self:

  • The default presentation slide size is 1050 x 700.
  • To publish online, run quarto publish gh-pages locally.
  • Note: The CSS for the reveal.js slides is different from the CSS of the websites:
    • Reveal-js slides are styled with the _extensions/nicebread/nicetheme theme
    • When the same slides are rendered as the continuous webpage (i.e., not as slides), they are styled with the general styles.css file in the top level folder. (This was relevant for the .alert class, which was initially displayed as white text on white background).
  • Right arrow (→): → Double headed arrow (↔): ↔
  • Full processing:
quarto render
quarto publish gh-pages

# With this option, it does not wait until the browser opens, and does not wait for your "Y" reply if you really want to publish:
quarto publish gh-pages --no-browser --no-prompt

To make this website/repository reusable for multiple runs of the course, I define some the course-specific content (e.g. specific links) as parameters in the _variables.yml file. This way, I can easily change the content for the next iteration of the course. Reference the variables in any .qmd file by using {{< var var_name >}}, e.g. {{< var homework_repo >}}.

On the overview page, the lectures are ordered by the hidden order parameter in the YAML frontmatter of each lecture .qmd file.

Link to Zenodo (to get a doi)

  1. Go to Zenodo --> My Account --> Github
  2. Enable the repository for Zenodo (switch it on)
  3. In Github: Create a new release. This will trigger Zenodo to create a new version.
  4. Copy the Zenodo badge into the README.md file.
  5. In Zenodo: Edit the metadata of the release
    1. Under "Keywords and subjects" add the keyword fairtheory (and others)
    2. Add the rendered website URL to the "Related identifiers" section, with "is source of and the URL:

  1. Add it to the "fairtheory" community (in the project view (not edit view) -> right sidebar -> "Communities" --> "Submit to community" --> search for "FAIR Theory Community" and select it)

Quizzes

Quiz questions are stored as R/exams .Rmd files. From this source, two output formats can be generated:

  1. Export as Particify .csv file, which can be imported into Particify for live quizzes during the lecture (participants scan a QR code and do it on their smartphones).
  2. Directly include in a qmd website via the exams2forms package.

in this repository, the .Rmd files for the quiz questions reside in a /quizzes subfolder under each presentation (i.e., the quizzes are nested in the folder they belong to). Only "uncategorized" quiz questions are in the general ./quizzes folder.

How to setup R/exams webquizzes

format:
  html:
    css: common/webex.css
    include-after-body: common/webex.js
  • include in R chunks, e.g.:
```{r, echo = FALSE, message = FALSE, results = "asis"}
library(exams2forms)
exams2forms("quizzes/swisscapital.Rmd", title = 'test quiz', solution=FALSE)
```