/
index.html
224 lines (207 loc) · 12.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
222
223
224
<!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>Provides Access to Datawrapper's API • DatawRappr</title>
<!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="favicon-16x16.png">
<link rel="icon" type="image/png" sizes="32x32" href="favicon-32x32.png">
<link rel="apple-touch-icon" type="image/png" sizes="180x180" href="apple-touch-icon.png">
<link rel="apple-touch-icon" type="image/png" sizes="120x120" href="apple-touch-icon-120x120.png">
<link rel="apple-touch-icon" type="image/png" sizes="76x76" href="apple-touch-icon-76x76.png">
<link rel="apple-touch-icon" type="image/png" sizes="60x60" href="apple-touch-icon-60x60.png">
<!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous">
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="bootstrap-toc.css">
<script src="bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous">
<!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="pkgdown.css" rel="stylesheet">
<script src="pkgdown.js"></script><meta property="og:title" content="Provides Access to Datawrapper's API">
<meta property="og:description" content="Connecting R to Datawrapper, allowing the creation and edits of charts via Datawrappers API.
It makes heavy use of the httr'-library and tries to manage the API-token for the user in the .Renviron-file.">
<meta property="og:image" content="/logo.png">
<!-- 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]-->
</head>
<body data-spy="scroll" data-target="#toc">
<div class="container template-home">
<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">DatawRappr</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.1.4</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="index.html">
<span class="fas fa fas fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="reference/index.html">Reference</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>
<a href="articles/map.html">Create a Map</a>
</li>
<li>
<a href="articles/usage.html">Using the API</a>
</li>
</ul>
</li>
<li>
<a href="news/index.html">Changelog</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/munichrocker/DatawRappr/">
<span class="fab fa fab fa-github fa-lg"></span>
</a>
</li>
</ul>
</div>
<!--/.nav-collapse -->
</div>
<!--/.container -->
</div>
<!--/.navbar -->
</header><div class="row">
<div class="contents col-md-9">
<div id="datawrappr-" class="section level1">
<div class="page-header"><h1 class="hasAnchor">
<a href="#datawrappr-" class="anchor"></a>DatawRappr <img src="reference/figures/logo.png" align="right">
</h1></div>
<p>The goal of DatawRappr is to provide a wrapper for Datawrapper’s API to connect data from R directly with Datawrapper’s charts capabilities. It uses the new <a href="https://developer.datawrapper.de/v3.0/docs">API version 3.0</a>.</p>
<div id="key-features" class="section level2">
<h2 class="hasAnchor">
<a href="#key-features" class="anchor"></a>Key features:</h2>
<ul>
<li>Manages and automatically retrieves the API-key locally via <code><a href="reference/datawrapper_auth.html">datawrapper_auth()</a></code>
</li>
<li>Creates, deletes or publishes charts on Datawrapper</li>
<li>Sends Dataframes from R directly to Datawrapper - without having to copy them in - with <code><a href="reference/dw_data_to_chart.html">dw_data_to_chart()</a></code>
</li>
</ul>
<p>All functions (except <code><a href="reference/datawrapper_auth.html">datawrapper_auth()</a></code>) are preceded by <code>dw_</code>:</p>
<ul>
<li>allows test calls to the API via <code><a href="reference/dw_test_key.html">dw_test_key()</a></code>
</li>
<li>lists all created charts: <code><a href="reference/dw_list_charts.html">dw_list_charts()</a></code>.</li>
<li>lists all folders: <code><a href="reference/dw_list_folders.html">dw_list_folders()</a></code>.</li>
<li>creates a new Datawrapper chart via <code><a href="reference/dw_create_chart.html">dw_create_chart()</a></code>
</li>
<li>copy a existing chart with: <code><a href="reference/dw_copy_chart.html">dw_copy_chart()</a></code>
</li>
<li>adds data from a R-dataframe to an existing Datawrapper chart via <code><a href="reference/dw_data_to_chart.html">dw_data_to_chart()</a></code>
</li>
<li>retrieves (<code><a href="reference/dw_retrieve_chart_metadata.html">dw_retrieve_chart_metadata()</a></code>) or edits metadata, description and visualization of an existing chart via <code><a href="reference/dw_edit_chart.html">dw_edit_chart()</a></code>
</li>
<li>publishes and republishes a Datawrapper chart via <code><a href="reference/dw_publish_chart.html">dw_publish_chart()</a></code>
</li>
<li>deletes an Datawrapper chart via <code><a href="reference/dw_delete_chart.html">dw_delete_chart()</a></code>
</li>
<li>exports a chart as png, pdf or svg (latter two only in paid accounts) with <code><a href="reference/dw_export_chart.html">dw_export_chart()</a></code>
</li>
</ul>
</div>
<div id="installation" class="section level2">
<h2 class="hasAnchor">
<a href="#installation" class="anchor"></a>Installation</h2>
<p>Right now this package is experimental and only available on Github:</p>
<pre class="{r}"><code><a href="https://devtools.r-lib.org//reference/remote-reexports.html"># install.packages("devtools") # if not already installed on your system
devtools::install_github("munichrocker/DatawRappr")</a></code></pre>
</div>
<div id="usage" class="section level2">
<h2 class="hasAnchor">
<a href="#usage" class="anchor"></a>Usage</h2>
<p>Add the package to your environment by running:</p>
<pre class="{r}"><code><a href="https://rdrr.io/pkg/DatawRappr/man">library(DatawRappr)</a></code></pre>
<div id="setting-up-the-api-key" class="section level3">
<h3 class="hasAnchor">
<a href="#setting-up-the-api-key" class="anchor"></a>Setting up the API-key</h3>
<p>To use the API you have to create an API key on Datawrapper.</p>
<p>Click on <strong>Dashboard</strong> - <strong>Settings</strong> and move down to the section that says <strong>API Access Tokens</strong>.</p>
<p>Click on <strong>Create new personal access token</strong>, enter a name and save the token:</p>
<p><img src="reference/figures/gif_api_key.gif"></p>
<p>Copy the API key in the clipboard and use</p>
<pre class="{r}"><code><a href="reference/datawrapper_auth.html">datawrapper_auth(api_key = "12345678")</a></code></pre>
<p>to save the key to our system. If a key already exists, you may add the argument <code>overwrite = TRUE</code> to <code><a href="reference/datawrapper_auth.html">datawrapper_auth()</a></code>.</p>
<p>To make sure, your key is working as expected, you can run</p>
<pre class="{r}"><code><a href="reference/dw_test_key.html">dw_test_key()</a></code></pre>
<p>with no arguments. It will then use the saved key from the environment. If the key is correct, you will receive a response from the API with personal details about your account - a <code>dw_user</code>-object that has no further use than to check your key.</p>
<p>Note: If you want to see your currently saved API key, you may use the helper function <code><a href="reference/dw_get_api_key.html">dw_get_api_key()</a></code>.</p>
<p>Congratulations, you’re good to go!</p>
</div>
</div>
<div id="under-the-hood" class="section level2">
<h2 class="hasAnchor">
<a href="#under-the-hood" class="anchor"></a>Under the hood</h2>
<p>This package makes heavy use of the <a href="https://github.com/r-lib/httr"><code>httr</code></a>-package, which on itself is a wrapper of the <a href="https://cran.r-project.org/web/packages/curl/index.html">curl</a>-package.</p>
</div>
<div id="further-links" class="section level2">
<h2 class="hasAnchor">
<a href="#further-links" class="anchor"></a>Further Links</h2>
<p>There is a <a href="https://developer.datawrapper.de/reference">API-documentation</a> and a <a href="https://developer.datawrapper.de/docs/getting-started">Getting Started guide with examples</a> from Datawrapper.</p>
<p>A full Package-documentation <a href="https://munichrocker.github.io/DatawRappr/">can be found here</a>.</p>
</div>
</div>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
<div class="links">
<h2>Links</h2>
<ul class="list-unstyled">
<li>Browse source code at <br><a href="https://github.com/munichrocker/DatawRappr/">https://github.com/munichrocker/DatawRappr/</a>
</li>
<li>Report a bug at <br><a href="https://github.com/munichrocker/DatawRappr/issues">https://github.com/munichrocker/DatawRappr/issues</a>
</li>
<li>Datawrapper Developers Page at <br><a href="https://developer.datawrapper.de/docs">https://developer.datawrapper.de/docs</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>
<a href="https://www.benedict-witzenberger.de">Benedict Witzenberger</a> <br><small class="roles"> Author, maintainer </small> </li>
<li>Bob Rudis <br><small class="roles"> Author </small> </li>
<li><a href="authors.html">All authors...</a></li>
</ul>
</div>
</div>
</div>
<footer><div class="copyright">
<p>Developed by <a href="https://www.benedict-witzenberger.de">Benedict Witzenberger</a>, Bob Rudis.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.5.1.</p>
</div>
</footer>
</div>
</body>
</html>