https://github.com/biostatsPMH/exceldata

A suite of functions to read and check files created with the DataDictionary.xlsm template
https://github.com/biostatsPMH/exceldata

Last synced: 4 months ago
JSON representation

A suite of functions to read and check files created with the DataDictionary.xlsm template

• Host: GitHub
• URL: https://github.com/biostatsPMH/exceldata
• Owner: biostatsPMH
• License: other
• Created: 2021-06-15T18:46:29.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-11-21T13:10:32.000Z (over 1 year ago)
• Last Synced: 2024-08-13T07:11:28.209Z (8 months ago)
• Language: R
• Size: 3.15 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - biostatsPMH/exceldata - A suite of functions to read and check files created with the DataDictionary.xlsm template (R)

README

        
---

output: github_document

editor_options: 

  markdown: 

    wrap: 72

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# exceldata

[![Lifecycle:

Stable](https://img.shields.io/badge/lifecycle-stable-green.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)

[![CRAN

status](https://www.r-pkg.org/badges/version/exceldata)](https://CRAN.R-project.org/package=exceldata)

[![metacran

downloads](https://cranlogs.r-pkg.org/badges/grand-total/exceldata)](https://cran.r-project.org/package=exceldata)

[![R-CMD-check](https://github.com/biostatsPMH/exceldata/workflows/R-CMD-check/badge.svg)](https://github.com/biostatsPMH/exceldata/actions)

The goal of exceldata is to facilitate the use of Excel as a data entry

tool for reproducible research. This package provides tools to automate

data cleaning and recoding of data by requiring a data dictionary to

accompany the Excel data. A macro-enabled template file has been created

to facilitate clean data entry including validation rules for live data

checking.

To download the Excel Template [Click

Here](https://github.com/biostatsPMH/exceldata/blob/main/DataDictionary0.1.0.xlsm)

and then click the download button ![](images/download_btn.png)

To view data in the required format without macros [Click

Here](https://github.com/biostatsPMH/exceldata/blob/main/inst/extdata/exampleData.xlsx)

and download

## Installation

You can install the released version of exceldata from

[CRAN](https://CRAN.R-project.org) with:

``` r

install.packages("exceldata")

```

And the development version from [GitHub](https://github.com/) with:

``` r

devtools::install_github("biostatsPMH/exceldata")

```

------------------------------------------------------------------------

## Documentation

[Online Documentation](https://biostatsPMH.github.io/exceldata/)

PDF Documentation: [Click

Here](https://github.com/biostatsPMH/exceldata/blob/main/docs/ExcelDictionaryUserManual.pdf)

and then click on `Download`

[Using the Excel

Template](https://biostatsPMH.github.io/exceldata/data-dictionary-1.html)

## Example

Example of importing the data and producing univariate plots to screen

for outliers.

```{r example}

library(exceldata)

exampleDataFile <- system.file("extdata", "exampleData.xlsx", package = "exceldata")

import <- importExcelData(exampleDataFile,dictionarySheet = 'DataDictionary',dataSheet = 'DataEntry')

# The imported data dictionary 

dictionary <- import$dictionary

head(dictionary)

# The imported data, with calculated variables

data <- import$data

head(data)

# Simple univariate plots with outliers 

plots <- plotVariables(data,dictionary,IDvar = 'ID',showOutliers = T)

# Not Run: Show plots in viewer

# plots

```