README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# DIYDDICurator

<!-- badges: start -->
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7405487.svg)](https://doi.org/10.5281/zenodo.7405487)
<!-- badges: end -->

## Description

DIYDDICurator is a graphic user interface to the `rddi` package. It is a
shiny app designed to streamline metadata generation for research data
sharing. It allows the user to input project metadata and generate a
valid [Data Documentation Initiative Codebook (DDI
2.5)](https://ddialliance.org/Specification/DDI-Codebook/2.5/) to
describe the study and data collected.

DDI elements and their attributes are listed in various tabs and
described using `handsontable` (<https://handsontable.com/>). By right
clicking on the table users can add or delete rows. A human readable
README, the DDI Codebook and the data is available for export in the
Export navigation menu.

## Installation

DIYDDICurator installation

``` r
devtools::install_github("nyuglobalties/diyddi")
```

## Launch DIY DDI Curator

``` r
library(diyddi)
curator()

# or
diyddi::curator()
```