Skip to content

Commit 3f0bac6

Browse files
aravindhebbaliaravindhebbali
authored
Merge pull request #36 from rsquaredacademy/develop
Documentation
2 parents 5d88d94 + 6d7aeef commit 3f0bac6

File tree

5 files changed

+110
-45
lines changed

5 files changed

+110
-45
lines changed

‎CONTRIBUTING.MD

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Contributing to inferr
2+
3+
This outlines how to propose a change to inferr.
4+
5+
### Fixing typos
6+
7+
Small typos or grammatical errors in documentation may be edited directly using
8+
the GitHub web interface, so long as the changes are made in the _source_ file.
9+
10+
* YES: you edit a roxygen comment in a `.R` file below `R/`.
11+
* NO: you edit an `.Rd` file below `man/`.
12+
13+
### Prerequisites
14+
15+
Before you make a substantial pull request, you should always file an issue and
16+
wait for someone from the team to respond. If you’ve found a
17+
bug, create an associated issue and illustrate the bug with a minimal
18+
[reprex](https://www.tidyverse.org/help/#reprex).
19+
20+
### Pull request process
21+
22+
* We recommend that you create a Git branch for each pull request (PR).
23+
* Look at the Travis and AppVeyor build status before and after making changes.
24+
The `README` should contain badges for any continuous integration services used
25+
by the package.
26+
* New code should follow the tidyverse [style guide](http://style.tidyverse.org).
27+
You can use the [styler](https://CRAN.R-project.org/package=styler) package to
28+
apply these styles, but please don't restyle code that has nothing to do with
29+
your PR.
30+
* We use [roxygen2](https://cran.r-project.org/package=roxygen2), with
31+
[Markdown syntax](https://cran.r-project.org/web/packages/roxygen2/vignettes/markdown.html),
32+
for documentation.
33+
* We use [testthat](https://cran.r-project.org/package=testthat). Contributions
34+
with test cases included are easier to accept.
35+
* For user-facing changes, add a bullet to the top of `NEWS.md` below the current
36+
development version header describing the changes made followed by your GitHub
37+
username, and links to relevant issue(s)/PR(s).
38+
39+
### Code of Conduct
40+
41+
Please note that this project is released with a [Contributor Code of
42+
Conduct](CONDUCT.md). By participating in this project you agree to
43+
abide by its terms.
44+
45+

‎ISSUE_TEMPLATE.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Please briefly describe your problem and what output you expect. If you have a
2+
question, please don't use this form. Instead, ask on <https://stackoverflow.com/>.
3+
4+
Please include a minimal reproducible example (AKA a reprex). If you've never heard of a [reprex](http://reprex.tidyverse.org/) before, start by reading <https://www.tidyverse.org/help/#reprex>.
5+
6+
---
7+
8+
Brief description of the problem
9+
10+
```r
11+
# insert reprex here
12+
```

‎README.Rmd

+17-24
Original file line numberDiff line numberDiff line change
@@ -12,28 +12,13 @@ knitr::opts_chunk$set(
1212
)
1313
```
1414

15-
inferr: Inferential statistics with R <img src="hex_inferr.png" height="100px" align="right" />
16-
-------------
17-
18-
**Author:** [Aravind Hebbali](http://www.aravindhebbali.com)<br/>
19-
**License:** [MIT](https://opensource.org/licenses/MIT)
15+
# inferr <img src="hex_inferr.png" height="100px" align="right" />
2016

2117
[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/inferr)](https://cran.r-project.org/package=inferr) [![cran checks](https://cranchecks.info/badges/summary/inferr)](https://cran.r-project.org/web/checks/check_results_inferr.html) [![Travis-CI Build Status](https://travis-ci.org/rsquaredacademy/inferr.svg?branch=master)](https://travis-ci.org/rsquaredacademy/inferr) [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/rsquaredacademy/inferr?branch=master&svg=true)](https://ci.appveyor.com/project/rsquaredacademy/inferr) [![Coverage status](https://codecov.io/gh/rsquaredacademy/inferr/branch/master/graph/badge.svg)](https://codecov.io/github/rsquaredacademy/inferr?branch=master) [![](https://cranlogs.r-pkg.org/badges/grand-total/inferr)](https://cran.r-project.org/package=inferr) ![](https://img.shields.io/badge/lifecycle-maturing-blue.svg)
2218

2319
## Overview
2420

25-
Inferential statistics allows us to make generalizations about populations using data drawn from the population.
26-
We use them when it is impractical or impossible to collect data about the whole population under study and instead,
27-
we have a sample that represents the population under study and using inferential statistics technique, we make
28-
generalizations about the population from the sample.
29-
30-
The **inferr** package:
31-
32-
- builds upon the statistical tests provided in **stats**
33-
- provides additional and flexible input options
34-
- more detailed and structured test results
35-
36-
As of version 0.1, **inferr** includes a select set of parametric and non-parametric statistical tests which are listed below:
21+
inferr builds upon the statistical tests provided in **stats**, provides additional and flexible input options and more detailed and structured test results. As of version 0.3, **inferr** includes a select set of parametric and non-parametric statistical tests which are listed below:
3722

3823
- One Sample t Test
3924
- Paired Sample t Test
@@ -67,13 +52,13 @@ devtools::install_github("rsquaredacademy/inferr")
6752

6853
Use `infer_launch_shiny_app()` to explore the package using a shiny app.
6954

70-
## Vignettes
55+
## Articles
7156

7257
- [Introduction to inferr](http://www.rsquaredacademy.com/inferr/articles/index.html)
7358

7459
## Usage
7560

76-
##### One Sample t Test
61+
#### One Sample t Test
7762

7863
```{r load, echo=FALSE, message=FALSE}
7964
library(inferr)
@@ -84,31 +69,31 @@ library(dplyr)
8469
infer_os_t_test(hsb, write, mu = 50, type = 'all')
8570
```
8671

87-
##### ANOVA
72+
#### ANOVA
8873

8974
```{r anova}
9075
infer_oneway_anova(hsb, write, prog)
9176
```
9277

93-
##### Chi Square Test of Independence
78+
#### Chi Square Test of Independence
9479

9580
```{r chi1}
9681
infer_chisq_assoc_test(hsb, female, schtyp)
9782
```
9883

99-
##### Levene's Test
84+
#### Levene's Test
10085

10186
```{r lev1}
10287
infer_levene_test(hsb, read, group_var = race)
10388
```
10489

105-
##### Cochran's Q Test
90+
#### Cochran's Q Test
10691

10792
```{r cochran}
10893
infer_cochran_qtest(exam, exam1, exam2, exam3)
10994
```
11095

111-
##### McNemar Test
96+
#### McNemar Test
11297

11398
```{r mc1}
11499
hb <-
@@ -120,5 +105,13 @@ hb <-
120105
infer_mcnemar_test(hb, himath, hiread)
121106
```
122107

108+
## Getting Help
109+
110+
If you encounter a bug, please file a minimal reproducible example using
111+
[reprex](https://reprex.tidyverse.org/index.html) on github. For questions and
112+
clarifications, use [StackOverflow](https://stackoverflow.com/).
113+
114+
## Code of Conduct
115+
123116
Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md).
124117
By participating in this project you agree to abide by its terms.

‎README.md

+19-21
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,14 @@
11

22
<!-- README.md is generated from README.Rmd. Please edit that file -->
3-
inferr: Inferential statistics with R <img src="hex_inferr.png" height="100px" align="right" />
4-
-----------------------------------------------------------------------------------------------
5-
6-
**Author:** [Aravind Hebbali](http://www.aravindhebbali.com)<br/> **License:** [MIT](https://opensource.org/licenses/MIT)
3+
inferr <img src="hex_inferr.png" height="100px" align="right" />
4+
================================================================
75

86
[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/inferr)](https://cran.r-project.org/package=inferr) [![cran checks](https://cranchecks.info/badges/summary/inferr)](https://cran.r-project.org/web/checks/check_results_inferr.html) [![Travis-CI Build Status](https://travis-ci.org/rsquaredacademy/inferr.svg?branch=master)](https://travis-ci.org/rsquaredacademy/inferr) [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/rsquaredacademy/inferr?branch=master&svg=true)](https://ci.appveyor.com/project/rsquaredacademy/inferr) [![Coverage status](https://codecov.io/gh/rsquaredacademy/inferr/branch/master/graph/badge.svg)](https://codecov.io/github/rsquaredacademy/inferr?branch=master) [![](https://cranlogs.r-pkg.org/badges/grand-total/inferr)](https://cran.r-project.org/package=inferr) ![](https://img.shields.io/badge/lifecycle-maturing-blue.svg)
97

108
Overview
119
--------
1210

13-
Inferential statistics allows us to make generalizations about populations using data drawn from the population. We use them when it is impractical or impossible to collect data about the whole population under study and instead, we have a sample that represents the population under study and using inferential statistics technique, we make generalizations about the population from the sample.
14-
15-
The **inferr** package:
16-
17-
- builds upon the statistical tests provided in **stats**
18-
- provides additional and flexible input options
19-
- more detailed and structured test results
20-
21-
As of version 0.1, **inferr** includes a select set of parametric and non-parametric statistical tests which are listed below:
11+
inferr builds upon the statistical tests provided in **stats**, provides additional and flexible input options and more detailed and structured test results. As of version 0.3, **inferr** includes a select set of parametric and non-parametric statistical tests which are listed below:
2212

2313
- One Sample t Test
2414
- Paired Sample t Test
@@ -53,15 +43,15 @@ Shiny App
5343

5444
Use `infer_launch_shiny_app()` to explore the package using a shiny app.
5545

56-
Vignettes
57-
---------
46+
Articles
47+
--------
5848

5949
- [Introduction to inferr](http://www.rsquaredacademy.com/inferr/articles/index.html)
6050

6151
Usage
6252
-----
6353

64-
##### One Sample t Test
54+
#### One Sample t Test
6555

6656
``` r
6757
infer_os_t_test(hsb, write, mu = 50, type = 'all')
@@ -84,7 +74,7 @@ infer_os_t_test(hsb, write, mu = 50, type = 'all')
8474
#> --------------------------------------------------------------------------------
8575
```
8676

87-
##### ANOVA
77+
#### ANOVA
8878

8979
``` r
9080
infer_oneway_anova(hsb, write, prog)
@@ -111,7 +101,7 @@ infer_oneway_anova(hsb, write, prog)
111101
#> Root MSE = 8.6392 Adj R-squared = 0.1693
112102
```
113103

114-
##### Chi Square Test of Independence
104+
#### Chi Square Test of Independence
115105

116106
``` r
117107
infer_chisq_assoc_test(hsb, female, schtyp)
@@ -129,7 +119,7 @@ infer_chisq_assoc_test(hsb, female, schtyp)
129119
#> ----------------------------------------------------
130120
```
131121

132-
##### Levene's Test
122+
#### Levene's Test
133123

134124
``` r
135125
infer_levene_test(hsb, read, group_var = race)
@@ -154,7 +144,7 @@ infer_levene_test(hsb, read, group_var = race)
154144
#> -------------------------------------------------------------------------
155145
```
156146

157-
##### Cochran's Q Test
147+
#### Cochran's Q Test
158148

159149
``` r
160150
infer_cochran_qtest(exam, exam1, exam2, exam3)
@@ -167,7 +157,7 @@ infer_cochran_qtest(exam, exam1, exam2, exam3)
167157
#> ----------------------
168158
```
169159

170-
##### McNemar Test
160+
#### McNemar Test
171161

172162
``` r
173163
hb <-
@@ -212,4 +202,12 @@ infer_mcnemar_test(hb, himath, hiread)
212202
#> ----------------------
213203
```
214204

205+
Getting Help
206+
------------
207+
208+
If you encounter a bug, please file a minimal reproducible example using [reprex](https://reprex.tidyverse.org/index.html) on github. For questions and clarifications, use [StackOverflow](https://stackoverflow.com/).
209+
210+
Code of Conduct
211+
---------------
212+
215213
Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.

‎SUPPORT.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Getting help with inferr
2+
3+
Thanks for using inferr. Please follow the below steps before filing an issue:
4+
5+
* Start by making a minimal **repr**oducible **ex**ample using the
6+
[reprex](http://reprex.tidyverse.org/) package.
7+
* If it's a question: post it on StackOverflow.
8+
* If it's a bug: file an issue.
9+
* If you're not sure, please feel free to email us at [email protected]
10+
11+
Before opening a new issue, be sure to [search issues and pull requests](https://github.com/rsquaredacademy/inferr/issues) to make sure the bug hasn't been reported and/or already fixed in the development version. By
12+
default, the search will be pre-populated with `is:issue is:open`. You can
13+
[edit the qualifiers](https://help.github.com/articles/searching-issues-and-pull-requests/)
14+
(e.g. `is:pr`, `is:closed`) as needed. For example, you'd simply
15+
remove `is:open` to search _all_ issues in the repo, open or closed.
16+
17+
Thanks for your help!

0 commit comments

Comments
 (0)