Data

Tools

Indexes

Applications

Experiments

Open Source Science

vtable

An R package for creating Variable Documentation Files

https://github.com/nickch-k/vtable

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    3 of 4 committers (75.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (18.7%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

An R package for creating Variable Documentation Files

Basic Info
Statistics
  • Stars: 40
  • Watchers: 2
  • Forks: 6
  • Open Issues: 2
  • Releases: 0
Created over 7 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog License Citation

README.Rmd 

---
output: github_document
always_allow_html: true
---



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



[![](http://cranlogs.r-pkg.org/badges/grand-total/vtable?color=orange)](https://cran.r-project.org/package=vtable) [![](http://cranlogs.r-pkg.org/badges/last-month/vtable?color=green)](https://cran.r-project.org/package=vtable) [![](https://www.r-pkg.org/badges/version/vtable?color=blue)](https://cran.r-project.org/package=vtable) [![CRAN
checks](https://cranchecks.info/badges/summary/vtable)](https://cran.r-project.org/web/checks/check_results_vtable.html) [![CRAN status](https://www.r-pkg.org/badges/version/vtable)](https://CRAN.R-project.org/package=vtable)



The **vtable** package is designed to help you quickly and efficiently look at and document your data.

There are three main functions in **vtable**:

1. `vtable`, or `vt` for short, shows you information about the variables in your data set, including variable labels, in a way that is easy to use "find in page" to search through. It was designed to be similar to Stata's "Variables" panel.
2. `sumtable` or `st` for short, provides a table of summary statistics. It is very similar in spirit to the summary statistics function of `stargazer::stargazer()` except that it accepts `tibble`s, handles factor variables, and makes by-group statistics and group tests easy.
3. `labeltable` provides a table of value labels, either for variables labelled with **sjlabelled** or **haven** or similar, or for when you want to see how the values of one column line up with the values of another.

All three of these functions are built with the intent of being *fast*. Not so much fast to *run*, but fast to *use*. The defaults are intended to be good defaults, and the output by default prints to the Viewer tab (in RStudio) or the browser (outside RStudio) so you can see it immediately, and continue to look at it as you work on your data. 

You could almost certainly build your own highly-customized version of `vtable`, But why do that when you can just do `vt(df)` and see the information you need to see? And there are eight million packages that make summary statistics tables to your exact specifications if you tweak them. But there's a good chance that `st(df)` does what you want. If you want something real out there, that's when you can break out the big guns.

All three main **vtable** functions can produce HTML, LaTeX, `data.frame`, CSV, or `knitr::kable()` output.

## Installation

You can install vtable from CRAN. Note that the documentation on this site refers to the development version, and so may not work perfectly for the CRAN version. But the two will usually be the same.: 

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

### Development version 

The development version can be installed from [GitHub](https://github.com/):

``` r
# install.packages("remotes")
remotes::install_github("NickCH-K/vtable")
```
## vtable Example

I'll just do a brief example here, using the `iris` we all know and love. Output will be to `kable` since this is an RMarkdown document.

```{r}
data(iris)

# Basic vtable
vt(iris)
```

There are plenty of options if we want to go nuts, but let's keep it simple and just ask for a little more with `lush`

```{r}
vt(iris, lush = TRUE)
```

## sumtable Example

Let's stick with `iris`!

```{r}
# Basic summary stats
st(iris)
```

Note that `sumtable` allows for much more customization than `vtable` since there's a heightened chance you want it for a paper or something. But I'll leave that to the more detailed documentation. For now just note it does by-group stats, either in "`group.long`" format (multiple `sumtable`s stacked on top of each other), or by default, in columns, with an option to add a group test.

Grouped `sumtables` look a little nicer in formats that suport multi-column cells like HTML and LaTeX. 

**These tables include multi-column cells, which are not supported in the `kable` output, but are supported by `vtable`'s `dftoHTML` and `dftoLaTeX` functions. They look nicer in the HTML or LaTeX output.**

```{r}
st(iris, 
   group = 'Species', 
   group.test = TRUE)
```

## labeltable Example

For this we'll need labeled values. 

```{r}
data(efc, package = 'sjlabelled')

# Now shoot - how was gender coded?
labeltable(efc$e16sex)
```

`labeltable` can also be used to see, for values of one variable, what values are present of other variables. This is intended for use if one variable is a recode, simplification, or lost-labels version of another, but hey, go nuts.

```{r}
labeltable(efc$e15relat,efc$e16sex,efc$e42dep)
```

Owner

  • Login: NickCH-K
  • Kind: user
  • Location: Seattle, WA
  • Company: Seattle University

Economics professor at Seattle University (previously CSU Fullerton). Econometrics, causality, and visualization. Usually R, sometimes Stata or Python.

Citation (CITATION.cff) 

# YAML 1.2
---
abstract: "This is an R package for the purpose of viewing information about data while working on it. vtable() automatically generates and displays a table of information about the variables in a data set, including name, class, range, labels, and summary statistics."
authors: 
  -
    affiliation: "Seattle University"
    family-names: "Huntington-Klein"
    given-names: Nick
    orcid: "https://orcid.org/https://orcid.org/0000-0002-7352-3991"
cff-version: "1.1.0"
date-released: 2018
license: "MIT + file LICENSE"
message: "If you use this software, please cite it using these metadata."
repository-code: "https://github.com/NickCH-K/vtable"
title: "vtable: A quick and easy variable browser for R."
version: "1.3.3"
...

GitHub Events

Total
  • Issues event: 4
  • Watch event: 1
  • Issue comment event: 8
  • Push event: 3
Last Year
  • Issues event: 4
  • Watch event: 1
  • Issue comment event: 8
  • Push event: 3

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 88
  • Total Committers: 4
  • Avg Commits per committer: 22.0
  • Development Distribution Score (DDS): 0.42
Past Year
  • Commits: 11
  • Committers: 1
  • Avg Commits per committer: 11.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
NickCH-K 4****K 51
NickCH-K n****n@f****u 27
Huntington-Klein n****n@A****U 9
“John-Henry “****o@u****” 1
Committer Domains (Top 20 + Academic)
uchicago.edu”: 1 ad.fullerton.edu: 1 fullerton.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 28
  • Total pull requests: 1
  • Average time to close issues: about 1 month
  • Average time to close pull requests: about 4 hours
  • Total issue authors: 24
  • Total pull request authors: 1
  • Average comments per issue: 2.79
  • Average comments per pull request: 4.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 0
  • Average time to close issues: about 12 hours
  • Average time to close pull requests: N/A
  • Issue authors: 2
  • Pull request authors: 0
  • Average comments per issue: 1.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • daaronr (2)
  • johnhenrypezzuto (2)
  • NickCH-K (2)
  • grantmcdermott (2)
  • L3ft2di3 (1)
  • rossellhayes (1)
  • adcascone (1)
  • bberger94 (1)
  • yiqinfu (1)
  • Conny42 (1)
  • JonatHorowitz (1)
  • ghost (1)
  • yjin-chae (1)
  • Kudusch (1)
  • JGWestie (1)
Pull Request Authors
  • johnhenrypezzuto (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 2,101 last-month
  • Total dependent packages: 2
  • Total dependent repositories: 6
  • Total versions: 21
  • Total maintainers: 1
cran.r-project.org: vtable

Variable Table for Variable Documentation

  • Versions: 21
  • Dependent Packages: 2
  • Dependent Repositories: 6
  • Downloads: 2,101 Last month
Rankings
Downloads: 5.5%
Stargazers count: 8.4%
Average: 10.1%
Forks count: 10.8%
Dependent repos count: 11.9%
Dependent packages count: 13.7%
Maintainers (1)
nhuntington-klein@seattleu.edu
Last synced: 7 months ago

Dependencies

DESCRIPTION cran
  • kableExtra * depends
  • haven * imports
  • knitr * imports
  • rstudioapi * imports
  • sjlabelled * imports
  • stats * imports
  • utils * imports
  • rmarkdown * suggests
  • survey * suggests