/
reporting.html
245 lines (224 loc) · 10.2 KB
/
reporting.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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html>
<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>Reporting with RMarkdown • ghtrackr</title>
<!-- jquery --><script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script><!-- Bootstrap --><link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script><!-- Font Awesome icons --><link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">
<!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js" integrity="sha384-cV+rhyOuRHc9Ub/91rihWcGmMmCXDeksTtCihMupQHSsi8GIIRDG0ThDc3HGQFJ3" 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><link href="../extra.css" rel="stylesheet">
<meta property="og:title" content="Reporting with RMarkdown">
<meta property="og:description" content="">
<meta property="og:image" content="/logo.png">
<meta name="twitter:card" content="summary">
<!-- mathjax --><script src="https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></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>
<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">
<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">ghtrackr</a>
<span class="label label-default" data-toggle="tooltip" data-placement="bottom" title="Released package">0.0.0.9000</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"></span>
</a>
</li>
<li>
<a href="../articles/index.html">Articles</a>
</li>
<li>
<a href="../reference/index.html">Documentation</a>
</li>
<li>
<a href="../news/index.html">News</a>
</li>
<li>
<a href="../CREDITS.html">Credits</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/emilyriederer/ghtrackr/">
<span class="fa fa-github"></span>
</a>
</li>
</ul>
</div>
<!--/.nav-collapse -->
</div>
<!--/.container -->
</div>
<!--/.navbar -->
</header><div class="row">
<div class="col-md-9 contents">
<div class="page-header toc-ignore">
<h1>Reporting with RMarkdown</h1>
<h4 class="author">Emily Riederer</h4>
<h4 class="date">2019-01-05</h4>
<small class="dont-index">Source: <a href="https://github.com/emilyriederer/ghtrackr/blob/master/vignettes/reporting.Rmd"><code>vignettes/reporting.Rmd</code></a></small>
<div class="hidden name"><code>reporting.Rmd</code></div>
</div>
<p>Communication is a critical part of project planning. For this, <code>ghtrackr</code> provides a family of <code>report</code> functions. These functions translate certain R objects like lists or dataframes into HTML code which will render nicely when knitted to HTML in an RMarkdown document.</p>
<div id="plans-to-do-lists" class="section level2">
<h2 class="hasAnchor">
<a href="#plans-to-do-lists" class="anchor"></a>Plans & To-Do Lists</h2>
<p>Recall that plans and to-do lists can be written in YAML. For example:</p>
<pre><code>- title: Data cleaning and validation
description: >
We will conduct data quality checks,
resolve issues with data quality, and
document this process
due_on: 2018-12-31T12:59:59Z
issue:
- title: Define data quality standards
body: List out decision rules to check data quality
assignees: [emilyriederer]
labels: [a, b, c]
- title: Assess data quality
body: Use assertthat to test decision rules on dataset
labels: [low]
- title: Resolve data quality issues
body: Conduct needed research to resolve any issues
- title: Exploratory data analysis
description: >
Create basic statistics and views to better
understand dataset and relationships
issue:
- title: Summary statistics
body: Calculate summary statistics
- title: Visualizations
body: Create univariate and bivariate plots</code></pre>
<p>The <code><a href="../reference/report_plan.html">report_plan()</a></code> function converts plans into formatted HTML for inclusion in RMarkdown documents for more aesthetic reporting.</p>
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r">plan <-<span class="st"> </span><span class="kw"><a href="../reference/read_plan.html">read_plan</a></span>(plan_path)
<span class="kw"><a href="../reference/report_plan.html">report_plan</a></span>(plan)</code></pre></div>
<p></p>
<p>
<strong> Data cleaning and validation </strong> <em> ( 0 % Complete - 0 / 3 Issues) </em>
</p>
<ul>
<li>
☐ Define data quality standards
</li>
<li>
☐ Assess data quality
</li>
<li>
☐ Resolve data quality issues
</li>
</ul>
<p>
<strong> Exploratory data analysis </strong> <em> ( 0 % Complete - 0 / 2 Issues) </em>
</p>
<ul>
<li>
☐ Summary statistics
</li>
<li>
☐ Visualizations
</li>
</ul>
<p></p>
<p>The <code><a href="../reference/report_todo.html">report_todo()</a></code> function works similarly.</p>
</div>
<div id="issues-milestones" class="section level2">
<h2 class="hasAnchor">
<a href="#issues-milestones" class="anchor"></a>Issues & Milestones</h2>
<p>Similarly, any issue-milestone data pulled back down from GitHub can be reported in a similar format with <code><a href="../reference/report_progress.html">report_progress()</a></code>.</p>
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="kw"><a href="../reference/report_progress.html">report_progress</a></span>(issues)</code></pre></div>
<p></p>
<strong> Data cleaning and validation </strong> <em> ( 100 % Complete - 3 / 3 Issues) </em>
<ul>
<li>
☑ Resolve data quality issues
</li>
<li>
☑ Assess data quality
</li>
<li>
☑ Define data quality standards
</li>
</ul>
<strong> Exploratory data analysis </strong> <em> ( 50 % Complete - 1 / 2 Issues) </em>
<ul>
<li>
☐ Visualizations
</li>
<li>
☑ Summary statistics
</li>
</ul>
<p></p>
</div>
<div id="discussions" class="section level2">
<h2 class="hasAnchor">
<a href="#discussions" class="anchor"></a>Discussions</h2>
<p>Additionally, full issues discussions can be pulled from GitHub and reformatted to HTML for long-term documentation with the <code><a href="../reference/report_discussion.html">report_discussion()</a></code> function.</p>
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r">issues <-<span class="st"> </span><span class="kw"><a href="../reference/get_issues.html">get_issues</a></span>(experigit, <span class="dt">number =</span> <span class="dv">163</span>) <span class="op">%>%</span><span class="st"> </span><span class="kw"><a href="../reference/parse_issues.html">parse_issues</a></span>()
comments <-<span class="st"> </span><span class="kw"><a href="../reference/get_issue_comments.html">get_issue_comments</a></span>(experigit, <span class="dt">number =</span> <span class="dv">163</span>) <span class="op">%>%</span><span class="st"> </span><span class="kw"><a href="../reference/parse_issue_comments.html">parse_issue_comments</a></span>()</code></pre></div>
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="kw"><a href="../reference/report_discussion.html">report_discussion</a></span>(comments, issues)
<span class="co">#> Warning in if (!is.na(issue)) {: the condition has length > 1 and only the</span>
<span class="co">#> first element will be used</span></code></pre></div>
<strong>Issue: #163: A very important issue</strong><br>Created by emilyriederer on 2018-12-30<br>Closed on NA<br><a href="https://github.com/emilyriederer/experigit/issues/163%20"> Visit on GitHub </a>
<p></p>
<em>Issue Description: </em><br><blockquote>
This is the beginning of a conversation
</blockquote>
<p></p>
<p></p>
<hr>
<strong> emilyriederer ( OWNER ) wrote at 2018-12-30 : </strong>
<p></p>
<blockquote>
I’m just commenting to add more information.
</blockquote>
<p></p>
<p></p>
<hr>
<strong> emilyriederer ( OWNER ) wrote at 2018-12-30 : </strong>
<p></p>
<blockquote>
Actually, I disagree. My perspective is this.
</blockquote>
<p></p>
</div>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
<div id="tocnav">
<h2 class="hasAnchor">
<a href="#tocnav" class="anchor"></a>Contents</h2>
<ul class="nav nav-pills nav-stacked">
<li><a href="#plans-to-do-lists">Plans & To-Do Lists</a></li>
<li><a href="#issues-milestones">Issues & Milestones</a></li>
<li><a href="#discussions">Discussions</a></li>
</ul>
</div>
</div>
</div>
<footer><div class="copyright">
<p>Developed by Emily Riederer.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="http://pkgdown.r-lib.org/">pkgdown</a>.</p>
</div>
</footer>
</div>
</body>
</html>