https://github.com/dzhw/questionmetadatapreparation
Tools to generate and modify question metadata files for the MDM
https://github.com/dzhw/questionmetadatapreparation
mdm metadata question-metadata-preparation questions r
Last synced: 4 months ago
JSON representation
Tools to generate and modify question metadata files for the MDM
- Host: GitHub
- URL: https://github.com/dzhw/questionmetadatapreparation
- Owner: dzhw
- License: gpl-3.0
- Created: 2019-03-07T13:44:34.000Z (over 6 years ago)
- Default Branch: development
- Last Pushed: 2025-03-01T19:58:30.000Z (8 months ago)
- Last Synced: 2025-03-01T20:34:53.180Z (8 months ago)
- Topics: mdm, metadata, question-metadata-preparation, questions, r
- Language: R
- Size: 30.5 MB
- Stars: 1
- Watchers: 7
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE.md
Awesome Lists containing this project
README
---
output:
github_document:
html_preview: false
---
[](https://github.com/dzhw/questionMetadataPreparation/actions)
[](https://codecov.io/github/dzhw/questionMetadataPreparation?branch=master)
[](https://www.tidyverse.org/lifecycle/#stable)
[](https://github.com/dzhw/FDZ_Allgemein/wiki/Fragen-2.0)
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# [Question Metadata Preparation](https://dzhw.github.io/questionMetadataPreparation/)
This [R](https://www.r-project.org/about.html) package ([Question Metadata Preparation](https://dzhw.github.io/questionMetadataPreparation/)) helps preparing question-metadata for the [MDM](https://metadata.fdz.dzhw.eu) 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.
```{r, eval = FALSE}
install.packages("devtools", dependencies = TRUE)
devtools::install_github("dzhw/questionMetadataPreparation")
```
After setting up devtools you can install all required R packages with
``` bash
R -e 'devtools::install_deps(dep = T)'
```
During development you should start an R session in the project root in order to run:
```{r, eval = FALSE}
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
``` bash
R CMD build .
```
Before pushing to Github (and thus kicking of CI) you should run
``` bash
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.bat`which installs the latest commit on `master`.
# Usefull links, further documentation
- [Further Documentation](https://github.com/dzhw/FDZ_Allgemein/wiki/Fragen-(Questions))
## Having trouble?
Please file an issue in our [issue tracker](https://github.com/dzhw/metadatamanagement/issues)