Skip to content

Commit

Permalink
update README and add CRAN link to package website.
Browse files Browse the repository at this point in the history
  • Loading branch information
aravindhebbali committed Dec 29, 2016
1 parent d790e5b commit 598394a
Show file tree
Hide file tree
Showing 5 changed files with 60 additions and 6 deletions.
4 changes: 2 additions & 2 deletions R/output.R
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ print_cross <- function(data) {


print_cross2 <- function(data) {

# output formatting
p <- length(data$variable_levels)
q <- p + 2
Expand Down Expand Up @@ -175,7 +175,7 @@ print_cross2 <- function(data) {
cat(" |")
cat("\n-", rep("---------------", q), sep = "")
cat("\n")
}
}
cat("|")
for (i in seq_along(data$column_totals)) {
cat(formatter(data$column_totals[i]), "|")
Expand Down
37 changes: 35 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ knitr::opts_chunk$set(
)
```

descriptr
=========
# descriptr <img src="descriptr.jpg" align="right" />

[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/descriptr)](https://cran.r-project.org/package=descriptr)
[![Travis-CI Build Status](https://travis-ci.org/rsquaredacademy/descriptr.svg?branch=master)](https://travis-ci.org/rsquaredacademy/descriptr)
Expand Down Expand Up @@ -63,5 +62,39 @@ for the following distributions:
- F
- t

## Links

- [Shiny App][shinyapp]
- [Website][website]
- [Tutorials][tutorials]
- [YouTube][youtube]

## Similar Packages

- [tigerstats][tiger]
- [describer][describe]

## Credits

We have extensively referred to [R Packages][packages] by Hadley Wickham and
[Writing R Extensions][extension] while creating this package. The [devtools][dev]
and [testthat][test] package were of immense help. Before submitting the package
to [CRAN][cran], we submitted it to [rhub][rub] several times to ensure there were
no errors. We also went through the repositories of several R packages and learnt
a lot. Thanks to R commmunity, R Core team, R Consortium and Hadley Wickham.

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.

[shinyapp]: http://rsquaredlabs.com:3838/explorer/
[website]: https://rsquaredacademy.github.io/descriptr/
[tutorials]: http://rsquaredacademy.com/
[youtube]: https://www.youtube.com/user/rsquaredin
[tiger]: https://cran.r-project.org/web/packages/tigerstats/
[describe]: https://cran.r-project.org/web/packages/describer/
[packages]: http://r-pkgs.had.co.nz/
[extension]: https://cran.r-project.org/doc/manuals/r-release/R-exts.html
[dev]: https://cran.r-project.org/web/packages/devtools/
[test]: https://cran.r-project.org/web/packages/testthat/
[cran]: https://cran.r-project.org/
[rub]: https://builder.r-hub.io/
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->
descriptr
=========
descriptr <img src="descriptr.jpg" align="right" />
===================================================

[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/descriptr)](https://cran.r-project.org/package=descriptr) [![Travis-CI Build Status](https://travis-ci.org/rsquaredacademy/descriptr.svg?branch=master)](https://travis-ci.org/rsquaredacademy/descriptr) [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/rsquaredacademy/descriptr?branch=master&svg=true)](https://ci.appveyor.com/project/rsquaredacademy/descriptr) [![Coverage Status](https://img.shields.io/codecov/c/github/rsquaredacademy/descriptr/master.svg)](https://codecov.io/github/rsquaredacademy/descriptr?branch=master)

Expand Down Expand Up @@ -47,4 +47,23 @@ Functions have been defined to visualize and compute percentiles/probabilities f
- F
- t

Links
-----

- [Shiny App](http://rsquaredlabs.com:3838/explorer/)
- [Website](https://rsquaredacademy.github.io/descriptr/)
- [Tutorials](http://rsquaredacademy.com/)
- [YouTube](https://www.youtube.com/user/rsquaredin)

Similar Packages
----------------

- [tigerstats](https://cran.r-project.org/web/packages/tigerstats/)
- [describer](https://cran.r-project.org/web/packages/describer/)

Credits
-------

We have extensively referred to [R Packages](http://r-pkgs.had.co.nz/) by Hadley Wickham and [Writing R Extensions](https://cran.r-project.org/doc/manuals/r-release/R-exts.html) while creating this package. The [devtools](https://cran.r-project.org/web/packages/devtools/) and [testthat](https://cran.r-project.org/web/packages/testthat/) package were of immense help. Before submitting the package to [CRAN](https://cran.r-project.org/), we submitted it to [rhub](https://builder.r-hub.io/) several times to ensure there were no errors. We also went through the repositories of several R packages and learnt a lot. Thanks to R commmunity, R Core team, R Consortium and Hadley Wickham.

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.
2 changes: 2 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ templates:

home:
links:
- text: Download from CRAN at
href: https://CRAN.R-project.org/package=descriptr
- text: Learn more
href: http://www.rsquaredacademy.com

Expand Down
Binary file added descriptr.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 598394a

Please sign in to comment.