Finalize Package: Ensuring all requirements are met

[gweisert]

3.1 Anforderungskatalog für Paket • in der themenspezifischen Aufgabenstellung genannten Punkte – möglichst fehlerfrei Implementierung🆗 – Bereitstellung aller Funktionalität in einem R-Paket🆗 • sinnvolle Dokumentation aller User-Funktionen • sinnvolle Fehlerausgaben der User-Funktionen (zB stopifnot()) • mindestens ein sinnvoller Test für jede User-Funktion 🆗 • mindestens eine Vignette, die sinnvoll die Fähigkeiten des Paketes demonstriert • Simulationsstudie falls gefordert • Shiny-App falls gefordert • Das Paket muss devtools::check() ohne Fehler überstehen. 🆗 • Das Paket als bundled package muss mit devtools::install_local() installiert werden können. See HeiBox document

[gweisert]

@dopu2k16 I can translate any parts that are unclear, if you want.

[gweisert]

• sinnvolle Dokumentation aller User-Funktionen • sinnvolle Fehlerausgaben der User-Funktionen (zB stopifnot()) • mindestens ein sinnvoller Test für jede User-Funktion

User functions are all functions marked @export, I think. Make sure all your exported functions are tested, I'll add tests for all the utility stuff real quick. I won't do error checking in the norms or metrics though, since that would probably slow down our algorithms significantly.

[gweisert]

• Das Paket als bundled package muss mit devtools::install_local() installiert werden können. See HeiBox document

This does work so far. Once everyone is done finalizing their documentation and thedevtools::check() issues are gone I'll test this again.

[gweisert]

3.1 Anforderungskatalog für Paket • in der themenspezifischen Aufgabenstellung genannten Punkte – möglichst fehlerfrei Implementierung🆗 – Bereitstellung aller Funktionalität in einem R-Paket🆗 • sinnvolle Dokumentation aller User-Funktionen • sinnvolle Fehlerausgaben der User-Funktionen (zB stopifnot()) • mindestens ein sinnvoller Test für jede User-Funktion 🆗 • mindestens eine Vignette, die sinnvoll die Fähigkeiten des Paketes demonstriert • Simulationsstudie falls gefordert • ~Shiny-App falls gefordert~ • Das Paket muss devtools::check() ohne Fehler überstehen. • Das Paket als bundled package muss mit devtools::install_local() installiert werden können. See HeiBox document

Package Requirements

• project specific tasks as correct an implementation as possible provide the functionality in an R package
• useful documentation of all user functions
• useful error message for all user functions
• at least one useful test for every use function
• at least one vignette demonstrating the package's capabilities
• simulation study
• devtools::check() has to run without error
• the bundled package can be installed using devtools::install_local()