README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r setup, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "##",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```


```{r, include=FALSE}
options("width"=110)
tmp <- packageDescription( basename(getwd()) )
```


```{r, results='asis', echo=FALSE}
cat("##", tmp$Title)
```



```{r, include=FALSE}
filelist.R   <- list.files("R", recursive = TRUE, pattern="\\.R$", ignore.case = TRUE, full.names = TRUE)
filelist.tests   <- list.files("tests", recursive = TRUE, pattern="\\.R$", ignore.case = TRUE, full.names = TRUE)
filelist.cpp <- list.files("src", recursive = TRUE, pattern="\\.cpp$", ignore.case = TRUE, full.names = TRUE)
lines.R      <- unlist(lapply(filelist.R, readLines))
lines.tests  <- unlist(lapply(filelist.tests, readLines))
lines.cpp    <- unlist(lapply(filelist.cpp, readLines))
length.R     <- length(grep("(^\\s*$)|(^\\s*#)|(^\\s*//)", lines.R,  value = TRUE, invert = TRUE))
length.tests <- length(grep("(^\\s*$)|(^\\s*#)|(^\\s*//)", lines.tests,  value = TRUE, invert = TRUE))
length.cpp   <- length(grep("(^\\s*$)|(^\\s*#)|(^\\s*//)", lines.cpp,  value = TRUE, invert = TRUE))
```



**Status**


*lines of R code:* `r length.R`, *lines of test code:* `r length.tests`

[![repo status](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)
<a href="https://travis-ci.org/petermeissner/`r tmp$Package`">
<img src="https://api.travis-ci.org/petermeissner/`r tmp$Package`.svg?branch=master">
<a/>
[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/petermeissner/`r tmp$Package`?branch=master&svg=true)](https://ci.appveyor.com/project/petermeissner/ical)
<a href="https://cran.r-project.org/package=`r tmp$Package`">
<img src="http://www.r-pkg.org/badges/version/`r tmp$Package`">
</a>
<a href="https://codecov.io/gh/petermeissner/`r tmp$Package`">
  <img src="https://codecov.io/gh/petermeissner/`r tmp$Package`/branch/master/graph/badge.svg" alt="Codecov" />
</a>
<img src="http://cranlogs.r-pkg.org/badges/grand-total/`r tmp$Package`">
<img src="http://cranlogs.r-pkg.org/badges/`r tmp$Package`">





**Development version**

```{r, include=FALSE}
source_files <- 
  grep(
    "/R/|/src/|/tests/",
    list.files(recursive = TRUE, full.names = TRUE), 
    value = TRUE
  )
last_change <- 
  as.character(
    format(max(file.info(source_files)$mtime), tz="UTC")
  )
```


```{r, results='asis', echo=FALSE}
cat(tmp$Version)
cat(" - ")
cat(stringr::str_replace(last_change, " ", " / "))
```

**Description**

```{r, results='asis', echo=FALSE}
cat(tmp$Description)
```


**License**

```{r, results='asis', echo=FALSE}
cat(tmp$License, "<br>")
cat(tmp$Author)
``` 


## Installation

You can install the released version of tabit from [CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("tabit")
```

And the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("petermeissner/tabit")
```
## Example

```{r load package}
# load package
library(tabit)
```


**simple vectors**
```{r}
# simple tabulation
tabit(mtcars$cyl)
```

**simple data.frames**
```{r}
# can we do this with data.frames
tabit(mtcars[, c("cyl", "am")])
```


**simple tibbles**
```{r}
# what about this tibble thing?
suppressPackageStartupMessages({
  library(dplyr)
})
mtcars %>% 
  select(cyl, am) %>% 
  tabit()
```


**grouped tibbles**
```{r}
# ... and grouped tibbles?
mtcars %>% 
  group_by(cyl, am) %>% 
  tabit()
```


**too much magic?**
```{r}
# use tabit_1() for vector usage
tabit_1(letters[1:4])

# use tabit_x for data.frames and tibbles
tabit_x(mtcars[, c("cyl", "am")])
```