forked from joachim-gassen/ExPanDaR
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.Rmd
119 lines (81 loc) · 4.69 KB
/
index.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
---
output: html_document
---
```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE, fig.align = "center", table.align = "center", warnings = FALSE)
library(ExPanDaR)
library(knitr)
```
<img src="logo.png" />
# ExPanDaR: Explore Your Data Interactively
[](http://www.repostatus.org/#active)
[](https://travis-ci.org/joachim-gassen/ExPanDaR)
[](https://cran.r-project.org/package=ExPanDaR)
[](https://cran.r-project.org/package=ExPanDaR)
## Overview
This is the documentation of the ExPanDaR (Explore Panel Data with R) package. ExPanDaR provides the code base for the ExPanD web app. ExPanD is a shiny based app supporting interactive exploratory data analysis.
ExPanD has two purposes:
- Provide a toolbox for researchers to explore data on the fly, now also
allowing them to download R notebook code that reflects their analysis.
- Enable users to assess the robustness of empirical evidence without providing them with access to the underlying data.
While I hope that ExPanD will be particularly helpful in the academic review, publication and replication process I also think that it is convenient for typical exploratory data analysis workflows. In addition, it has already proven to be helpful in the classroom.
This is what ExPanD looks like:
```{r, out.width = "90%", fig.align="center", fig.border = "none", echo=FALSE}
knitr::include_graphics("vignettes/figures/ExPanD_simple_03.jpg")
```
If you are interested to see what ExPanD has to offer without diving into R, click [here](https://jgassen.shinyapps.io/expand_wb/) to explore an instance of ExPanD that hosts World Bank data or click
[here](https://jgassen.shinyapps.io/expand_r3/) for a financial accounting and stock returns dataset of U.S. firms.
To see how ExPanD can be customized, take a look at [this blog post](https://joachim-gassen.github.io/2019/04/customize-your-interactive-eda-explore-the-fuel-economy-of-the-u.s.-car-market/) that generates [this display of the development of fuel economy in the U.S. car market](https://jgassen.shinyapps.io/expand_fuel_economy).
If you want to analyze your own data instead, you can also access a variant of ExPanD app [here](https://jgassen.shinyapps.io/expand/) that allows user-side data uploads. No worries: Your data won't be stored on the server and will get erased from memory as soon as you close the web connection.
## Installation
If you are in for the full treat and want to test ExPanD from within R, run the following
in your R session to install the ExPanDaR package from CRAN.
```{r, eval=FALSE}
install.packages("ExPanDaR")
library(ExPanDaR)
````
Or, if you want to install the current development version from Github:
```{r, eval=FALSE}
if (!require("devtools")) {
install.packages("devtools")
}
devtools::install_github("joachim-gassen/ExPanDaR")
library(ExPanDaR)
````
## Basic Usage
You can either start ExPanD without arguments so that it starts with a file upload dialog...
```{r, eval=FALSE}
ExPanD()
```
...or use it to explore a cross-sectional data frame with at least two numeric
variables...
```{r, eval=FALSE}
ExPanD(mtcars)
````
...or start with one of the two example datasets that come with the package to
understand hot to use it on long-format panel data.
Please note: The last parameter (`export_nb_option`) allows the user to download
a notebook and the data to continue the analysis in R. Maybe not the best idea
if you are hosting your app publicly and want to keep its data private.
```{r, eval=FALSE}
ExPanD(df = worldbank,
df_def = worldbank_data_def,
var_def = worldbank_var_def,
df_name = "World Bank Data",
config_list = ExPanD_config_worldbank,
export_nb_option = TRUE)
ExPanD(df = russell_3000,
df_def = russell_3000_data_def,
df_name = "Russell 3000",
config_list = ExPanD_config_russell_3000,
export_nb_option = TRUE)
````
## Use ExPanDaR functions in your own EDA workflow
Besides providing the ExPanD app, ExPanDaR comes with a set of functions that
might be helpful in your own exploratory data analysis workflow, e.g., functions
to quicky produce standard tables and plots. See the article "Using the
functions of the ExPanDaR package" on this page for a quick walk-trough.
## Further Information
For further information, please refer to the articles and function call
references available on this page.
Enjoy!