Ideas
This is the page for future ideas and important notes for documentation, for internal use.
Notes, Stand 22.4
Allgemein:
neue page für basic info: question types, outout formats, solution options
Internal Links
check use of backticks
Links to external doku formatierung ??? links oder beschreibung in den
Reihenfolge der Seiten?
Begriff: questions oder answers? -> answers
R code: formatiert mit Farben oder including knitr tags, zb auf structure .Rmd page (also direkt auf der Seite oder mit filter include)
Advanced examples (mit cloze, csv files, data generation, stories etc. ??? )
Auf moodle: interne doku und bsp aus statistik zur verfügung als advanced examples?
Soll folder structure (wurde nur bei Coaches verwendet) teil der doku sein bzw des how to? überhaupt notwendig? -> nein, in die interne doku
Shiny App:
- weiter verfolgen?
- hosten? wenn ja wo? (Quarto macht probleme), shinyapps.io?
- nicht hosten? -> wie bekommt man zugriff dazu?
- welche features?
- gehört neu strukturiert und aufgesetzt mit (fast) allen features in mind
Upload Moodle
seite erstellenanleitung schreiben
Home:
Autoren- Link zu Moodle Kurs
- Lizenz?
Read-me ?
First Steps:
letzer abschnitt
R-info:
- Abschnitt über R/exams ausweiten,
alle Autoren nennen
Project Setup:
Anleitungen schreiben
Structure Rmd:
template für download hinzufügen- ~~Code chunks anpassen, sodass knitr tags dabei sind (filter include-code-files verwenden!) -> nein, stattdessen eval = FALSE und warning ~~
Template verbessern: code chunks benennen, knitr tagsfehlende meta information beschreiben (exsection und numwidth)
Creation Rmd:
- umbenennen?
fertig schreiben
Conversion:
basic structure schreiben- advanced structure schreiben
- templates erstellen und einfügen
gehört in der form eigentlich in die interne dokubasic method (basic umwandlung ohne “schnickschnack”)- advanced method (Lukas’ script verallgemeinert)
vielleicht zusammenlegen mit Strucutre R-file ? ja
- explain exams2moodle arugments in advanced method
Add ons:
Abschnitt über graphs hinzufügen und schreibenabschnitt für dynamic context (“stories”)include_supplement beschreiben (bei bildern)
Basic Examples:
- final check, cross references
- check answers/questions confusion
1234- TODO: Leerzeilen aus Rmd files löschen und zeilen anpassen
- TODO: code chunks darstellung vereinheitlichen für alle examples, warning section hinzufügen/löschen
Advanced Examples:
Seite erstellen- Examples ausdenken
- Einfach nur zur homepage verlinken?? -> nein
- Ideen: random sample, stories, csv file, bilder
- ~download: zip file mit bild~
FAQ:
Fragen sammeln/ausdenkenFormat für fragen überlegen (dropdown? callout chunks?)- Antworten schreiben
References:
Erste Quellen und Resourcen zusammentragen- weitere Abschnitte/Themenbereiche überlegen
- zu diesen weitere Quellen suchen
Download center?
Seite erstellenalle templates einfügen- examples einfügen
Further Notes:
Internal references: https://machow.github.io/quartodoc/get-started/interlinks.html
How to include r markdown chunks (which are not executable)
include r chunks with visible settings
README? recommended order of reading documentationIf a document contains no R code chunks, the default inline syntax using curly braces, e. g.
`{r}`, will not work. Instead, the engine must be set to knitr in the YAML header like this:engine: knitr, and no curly braces must be used in the inline code:`r`.1
Writing style (internal)
Functions are written with () at the end and in backticks. Example:
answerlist()Backticks
testfor all R objects. Examples:questions,TRUE