bookdown pages für eat Pakete

iqb-research / IQB-Methods

Collection of materials coming from the Methods Team.

https://iqb-research.github.io/IQB-Methods/

3 stars 1 forks source link

bookdown pages für eat Pakete #113

Open grewered opened 2 months ago

grewered commented 2 months ago

es fehlen bookdown pages für folgende Pakete: @beckerbenj @sachseka @weirichs

[x] eatAnalysis
[x] eatATA
[ ] eatModel
[x] eatPrep
[ ] eatRep
[x] eatTools

die anderen müssten auf Aktualität geprüft werden: @beckerbenj @nickhaf

[x] eatCodebook
[x] eatFDZ
[x] eatGADS
[ ] eatPlot
[ ] eatRecode

grewered commented 2 months ago

Introduce some consistency, like "getting started", "Bildungstrend example" ...

beckerbenj commented 2 months ago

Worauf bezieht sich Aktualität denn bei den Bookdown-Pages? Auf die ReadMe? Die Vignetten? Ich habe da zumindest bei meinen Paketen keinen separaten Content als auf CRAN oder Github?

nickhaf commented 2 months ago

Worauf bezieht sich Aktualität denn bei den Bookdown-Pages? Auf die ReadMe? Die Vignetten? Ich habe da zumindest bei meinen Paketen keinen separaten Content als auf CRAN oder Github?

Dann sollte das passen, theoretisch könnte man nochmal rüberschauen ob alles schick aussieht und Nutzende gut an die Hand genommen werden, wenn sie das Paket verwenden wollen. Eventuell könnten wir noch darüber sprechen, ob wir die Bookdown-pages ein bisschen vereinheitlichen wollen, wie Edna oben geschreiben hat könnte man z.B. bei Relevanten Paketen eine Vignette für Bildungstrend-Examples erstellen, oder eine Getting Started Vignette.

beckerbenj commented 2 months ago

Für die Pakete, bei denen ich Repo-Owner bin, habe ich pkgdown aufgesetzt. Habe es auch für eatTools probiert, bin da aber glaube an Rechten gescheitert. @weirichs einfach mal ausprobieren, ob es trotzdem mit usethis::use_pkgdown_github_pages() funktioniert oder ob ich den jetzt existierenden gh-pages Branch löschen muss.

Bzgl. Aktualität der Seiten:

an eatFDZ und eatCodebook und der Dokumentation wird aktuell gearbeitet
eatGADS und eatATA sollten denke ich so passen
eatAnalysis ist allgemein etwas verwarlost; da würde ich vorher einige Sachen angehen, bevor man sich über den pkgdown-Auftritt Gedanken macht

weirichs commented 1 month ago

usethis::use_pkgdown_github_pages() funktioniert bei mir auch nicht, der hängt sich auf:

rstudio_haengt

beckerbenj commented 1 month ago

Probier jetzt nochmal neu, habe den gh-pages Branch gelöscht.