-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathindex.Rmd
executable file
·93 lines (69 loc) · 4.43 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
---
title: "Transparent Statistics Guidelines"
author: "Transparent Statistics in HCI Working Group (http://transparentstatistics.org/)"
description: "Guidelines, FAQ, and exemplar analyses"
site: "bookdown::bookdown_site"
output:
bookdown::gitbook:
split_bib: yes
css: css/style.css
config:
toc:
before: |
<li><a href="./index.html">Transparent Statistics Guidelines</a></li>
edit: https://github.com/transparentstats/guidelines/edit/master/%s
documentclass: book
date: "`r Sys.Date()`"
bibliography: [guides/references.bib]
biblio-style: apalike
link-citations: yes
github-repo: transparentstats/guidelines
---
# Preface {-}
<a href="https://github.com/transparentstats/guidelines"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_green_007200.png" alt="Fork me on GitHub"></a>
This document grew out of a Special Interest Group and Workshop to develop guidelines for transparent statistical communication in Human-Computer Interaction research.
The recommendations in this guideline are chosen to encourage transparency in the practice of statistics.
For more details on this position, see our [guiding principles](#principles).
```{r child = 'guides/doi.Rmd'}
```
## Organization {-}
This document is organized according to statistical topics.
Each chapter splits into two sections: FAQ and Exemplars.
The __FAQ section__ lists questions that are relevant to transparency practice.
We strive to allow random-access, to allow each reader to quickly find a compact answers to specific questions he/she has in mind.
Thus, this guideline assumes some knowledge about the topic.
We summarize such knowledge in earlier questions, but this is by no means exhaustive.
Whenever you found yourself disoriented, it might be helpful to skim one or two earlier questions or lookup definitions of statistical terms over the internet.
Whenever appropriate, we also point to other questions and parts of exemplars that are relevant.
The __Exemplars section__ supplements the FAQ by showing concrete cases in code and their interpretation(s).
In contrast to the FAQ, the exemplars should be read top-to-bottom: the earlier examples are building blocks of the latter.
## Using {-}
The text in this guideline is under CC-BY license, and the code is under MIT license.
These license choices mean that you can use any code from this guideline in your analysis and can release your code (even under other licenses).
## Limitations {-}
We focus on addressing issues that are commonly misunderstood and suboptimally practiced—intentionally or unintentionally.
Therefore, the scope and focus of this document is far narrower than being a complete textbook in statistics.
## Versions {-}
As the consensus in statistical practice evolves (as science evolves), this document is a living document.
For the most up-to-date version of the guideline, visit [the online guideline page](https://transparentstats.github.io/guidelines/) or [source on Github](https://github.com/transparentstats/guidelines).
## Citing {-}
You can cite this guideline with the following ACM reference format.
If you wish to cite a specific version, replace the DOI with the version-specific DOI and the date of publication as stated at the top of this webpage.
```
Transparent Statistics in Human–Computer Interaction working group. `r format(Sys.Date(), "%Y")`. Transparent Statistics Guidelines. (`r format(Sys.Date(), "%b %Y")`). DOI: http://dx.doi.org/10.5281/zenodo.`r doi_suffix` (Available at https://transparentstats.github.io/guidelines)
```
Here's the same thing in BibTeX format
```
@misc{TransparentStats`r format(Sys.Date(), "%b%Y")`,
title={{Transparent} {Statistics} {Guidelines}},
author={{Transparent} {Statistics} in {Human}–{Computer} {Interaction} {Working} {Group}},
DOI = {10.5281/zenodo.`r doi_suffix`},
month={`r format(Sys.Date(), "%b")`},
year={`r format(Sys.Date(), "%Y")`},
note={({Available} at https://transparentstats.github.io/guidelines)}
}
```
## Contributing {-}
We welcome help and feedback at all levels! If you would like to contribute, please see
[Contributing to the Guidelines](https://github.com/transparentstats/guidelines/wiki/Contributing-to-the-Guidelines). Especially, please have a look at the [Style Guide](https://github.com/transparentstats/guidelines/wiki/Style-Guide) and a
contributor [Code of Conduct](https://github.com/transparentstats/guidelines/wiki/Code-of-Conduct).