-
Notifications
You must be signed in to change notification settings - Fork 47
/
index.html
221 lines (201 loc) · 14.4 KB
/
index.html
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Explore Your Data Interactively • ExPanDaR</title>
<!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous">
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha256-eZrrJcwDc/3uDhsdt61sL2oOBY362qM3lon1gyExkL0=" crossorigin="anonymous">
<!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script><!-- sticky kit --><script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script><!-- pkgdown --><link href="pkgdown.css" rel="stylesheet">
<script src="pkgdown.js"></script><meta property="og:title" content="Explore Your Data Interactively">
<meta property="og:description" content="Provides a shiny-based front end (the 'ExPanD' app) and
a set of functions for exploratory data analysis. Run as a web-based
app, 'ExPanD' enables users to assess the robustness of empirical evidence
without providing them access to the underlying data. You can export a
notebook containing the analysis of 'ExPanD' and/or use the functions of the
package to support your exploratory data analysis workflow. Refer to the
vignettes of the package for more information on how to use 'ExPanD' and/or
the functions of this package.">
<meta property="og:image" content="/logo.png">
<meta name="twitter:card" content="summary">
<!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]--><!-- Global site tag (gtag.js) - Google Analytics --><script async src="https://www.googletagmanager.com/gtag/js?id=UA-119053376-1"></script><script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-119053376-1');
</script>
</head>
<body>
<div class="container template-article">
<header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="index.html">ExPanDaR</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.5.1</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="index.html">
<span class="fa fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="reference/index.html">Reference</a>
</li>
<li>
<a href="news/index.html">News</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
Articles
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li class="dropdown-header">ExPanD</li>
<li>
<a href="articles/use_ExPanD.html">Using ExPanD for Panel Data Exploration</a>
</li>
<li>
<a href="articles/customize_ExPanD.html">Customize ExPanD</a>
</li>
<li>
<a href="articles/ExPanD_notebook.html">Using the ExPanD Notebook function</a>
</li>
<li class="divider">
</li>
<li class="dropdown-header">'ExPanDaR' functions</li>
<li>
<a href="articles/ExPanDaR-functions.html">Using the functions of the 'ExPanDaR' package</a>
</li>
</ul>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://www.github.com/joachim-gassen/ExPanDaR">
<span class="fa fa-github"></span>
Code repository
</a>
</li>
</ul>
</div>
<!--/.nav-collapse -->
</div>
<!--/.container -->
</div>
<!--/.navbar -->
</header><div class="row">
<div class="col-md-9 contents">
<p><img src="logo.png"></p>
<div id="expandar-explore-your-data-interactively" class="section level1">
<div class="page-header"><h1 class="hasAnchor">
<a href="#expandar-explore-your-data-interactively" class="anchor"></a>ExPanDaR: Explore Your Data Interactively</h1></div>
<p><a href="http://www.repostatus.org/#active"><img src="http://www.repostatus.org/badges/latest/active.svg" alt="Project Status: Active – The project has reached a stable, usable state and is being actively developed."></a> <a href="https://travis-ci.org/joachim-gassen/ExPanDaR"><img src="https://travis-ci.org/joachim-gassen/ExPanDaR.svg?branch=master" alt="Travis-CI Build Status"></a> <a href="https://cran.r-project.org/package=ExPanDaR"><img src="http://www.r-pkg.org/badges/version/ExPanDaR" alt="CRAN_Status_Badge"></a> <a href="https://cran.r-project.org/package=ExPanDaR"><img src="http://cranlogs.r-pkg.org/badges/grand-total/ExPanDaR" alt="CRAN_Download_Badge"></a></p>
<div id="overview" class="section level2">
<h2 class="hasAnchor">
<a href="#overview" class="anchor"></a>Overview</h2>
<p>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.</p>
<p>ExPanD has two purposes:</p>
<ul>
<li>Provide a toolbox for researchers to explore data on the fly, now also allowing them to download R notebook code that reflects their analysis.</li>
<li>Enable users to assess the robustness of empirical evidence without providing them with access to the underlying data.</li>
</ul>
<p>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.</p>
<p>This is what ExPanD looks like:</p>
<p><img src="articles/figures/ExPanD_simple_03.jpg" width="90%" style="display: block; margin: auto;"></p>
<p>If you are interested to see what ExPanD has to offer without diving into R, click <a href="https://jgassen.shinyapps.io/expand_wb/">here</a> to explore an instance of ExPanD that hosts World Bank data or click <a href="https://jgassen.shinyapps.io/expand_r3/">here</a> for a financial accounting and stock returns dataset of U.S. firms.</p>
<p>If you want to analyze your own data instead, you can also access a variant of ExPanD app <a href="https://jgassen.shinyapps.io/expand/">here</a> 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.</p>
</div>
<div id="installation" class="section level2">
<h2 class="hasAnchor">
<a href="#installation" class="anchor"></a>Installation</h2>
<p>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.</p>
<div class="sourceCode" id="cb1"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb1-1" data-line-number="1"><span class="kw"><a href="https://www.rdocumentation.org/packages/utils/topics/install.packages">install.packages</a></span>(<span class="st">"ExPanDaR"</span>)</a>
<a class="sourceLine" id="cb1-2" data-line-number="2"><span class="kw"><a href="https://www.rdocumentation.org/packages/base/topics/library">library</a></span>(ExPanDaR)</a></code></pre></div>
<p>Or, if you want to install the current development version from Github:</p>
<div class="sourceCode" id="cb2"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb2-1" data-line-number="1"><span class="cf">if</span> (<span class="op">!</span><span class="kw"><a href="https://www.rdocumentation.org/packages/base/topics/library">require</a></span>(<span class="st">"devtools"</span>)) {</a>
<a class="sourceLine" id="cb2-2" data-line-number="2"> <span class="kw"><a href="https://www.rdocumentation.org/packages/utils/topics/install.packages">install.packages</a></span>(<span class="st">"devtools"</span>)</a>
<a class="sourceLine" id="cb2-3" data-line-number="3">}</a>
<a class="sourceLine" id="cb2-4" data-line-number="4">devtools<span class="op">::</span><span class="kw"><a href="https://www.rdocumentation.org/packages/devtools/topics/reexports">install_github</a></span>(<span class="st">"joachim-gassen/ExPanDaR"</span>)</a>
<a class="sourceLine" id="cb2-5" data-line-number="5"><span class="kw"><a href="https://www.rdocumentation.org/packages/base/topics/library">library</a></span>(ExPanDaR)</a></code></pre></div>
</div>
<div id="basic-usage" class="section level2">
<h2 class="hasAnchor">
<a href="#basic-usage" class="anchor"></a>Basic Usage</h2>
<p>You can either start ExPanD without arguments so that it starts with a file upload dialog…</p>
<div class="sourceCode" id="cb3"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb3-1" data-line-number="1"><span class="kw"><a href="reference/ExPanD.html">ExPanD</a></span>()</a></code></pre></div>
<p>…or use it to explore a cross-sectional data frame with at least two numeric variables…</p>
<div class="sourceCode" id="cb4"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb4-1" data-line-number="1"><span class="kw"><a href="reference/ExPanD.html">ExPanD</a></span>(mtcars)</a></code></pre></div>
<p>…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.</p>
<p>Please note: The last parameter (<code>export_nb_option</code>) 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.</p>
<div class="sourceCode" id="cb5"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb5-1" data-line-number="1"><span class="kw"><a href="reference/ExPanD.html">ExPanD</a></span>(<span class="dt">df =</span> worldbank, </a>
<a class="sourceLine" id="cb5-2" data-line-number="2"> <span class="dt">df_def =</span> worldbank_data_def, </a>
<a class="sourceLine" id="cb5-3" data-line-number="3"> <span class="dt">var_def =</span> worldbank_var_def,</a>
<a class="sourceLine" id="cb5-4" data-line-number="4"> <span class="dt">df_name =</span> <span class="st">"World Bank Data"</span>,</a>
<a class="sourceLine" id="cb5-5" data-line-number="5"> <span class="dt">config_list =</span> ExPanD_config_worldbank,</a>
<a class="sourceLine" id="cb5-6" data-line-number="6"> <span class="dt">export_nb_option =</span> <span class="ot">TRUE</span>)</a>
<a class="sourceLine" id="cb5-7" data-line-number="7"></a>
<a class="sourceLine" id="cb5-8" data-line-number="8"><span class="kw"><a href="reference/ExPanD.html">ExPanD</a></span>(<span class="dt">df =</span> russell_<span class="dv">3000</span>, </a>
<a class="sourceLine" id="cb5-9" data-line-number="9"> <span class="dt">df_def =</span> russell_<span class="dv">3000</span>_data_def, </a>
<a class="sourceLine" id="cb5-10" data-line-number="10"> <span class="dt">df_name =</span> <span class="st">"Russell 3000"</span>,</a>
<a class="sourceLine" id="cb5-11" data-line-number="11"> <span class="dt">config_list =</span> ExPanD_config_russell_<span class="dv">3000</span>,</a>
<a class="sourceLine" id="cb5-12" data-line-number="12"> <span class="dt">export_nb_option =</span> <span class="ot">TRUE</span>)</a></code></pre></div>
</div>
<div id="further-information" class="section level2">
<h2 class="hasAnchor">
<a href="#further-information" class="anchor"></a>Further Information</h2>
<p>For further information, please refer to the articles and function call references available on this page.</p>
<p>Enjoy!</p>
</div>
</div>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
<div class="links">
<h2>Links</h2>
<ul class="list-unstyled">
<li>Download from CRAN at <br><a href="https://cloud.r-project.org/package=ExPanDaR">https://cloud.r-project.org/package=ExPanDaR</a>
</li>
<li>Report a bug at <br><a href="https://github.com/joachim-gassen/ExPanDaR/issues">https://github.com/joachim-gassen/ExPanDaR/issues</a>
</li>
</ul>
</div>
<div class="license">
<h2>License</h2>
<ul class="list-unstyled">
<li>
<a href="https://opensource.org/licenses/mit-license.php">MIT</a> + file <a href="LICENSE-text.html">LICENSE</a>
</li>
</ul>
</div>
<div class="developers">
<h2>Developers</h2>
<ul class="list-unstyled">
<li>Joachim Gassen <br><small class="roles"> Author, maintainer </small> <a href="https://orcid.org/0000-0003-4364-2911" target="orcid.widget"><img src="https://members.orcid.org/sites/default/files/vector_iD_icon.svg" class="orcid" alt="ORCID" height="16"></a> </li>
</ul>
</div>
</div>
</div>
<footer><div class="copyright">
<p>Developed by Joachim Gassen.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.3.0.</p>
</div>
</footer>
</div>
</body>
</html>