Question Metadata Preparation

This R package (Question Metadata Preparation) helps preparing question-metadata for the MDM of the research data center of the DZHW. If you do not work for the research data center of the DZHW, this package will probably be only useful for learning purposes, as it is specifically designed to help with our internal processes.

Installation of development version

Developers need to setup the R devtools on their machine.

install.packages("devtools", dependencies = TRUE)
devtools::install_github("dzhw/questionMetadataPreparation")

After setting up devtools you can install all required R packages with

R -e 'devtools::install_deps(dep = T)'

During development you should start an R session in the project root in order to run:

devtools::load_all() # loads the project from the current directory
devtools::install() # installs the project from the current directory
devtools::test() # runs the test_that tests

You can build the package on your local machine with

R CMD build .

Before pushing to Github (and thus kicking of CI) you should run

R CMD check *tar.gz

Deployment

The scripts under /bin must be copied to //faust/abt4/FDZ/4_Datenaufnahme/_Organisation/_Vorlage_Ordnerstruktur/DAP-id/vX.X.X/4_Dokumentation/questions. New releases can be installed by the users by executing /bin/install_questionMetadataPreparation.batwhich installs the latest commit on master.

Usefull links, further documentation

• Further Documentation

Having trouble?

Please file an issue in our issue tracker