README.Rmd

---
output: github_document
---

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

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```
# haven <a href='https://haven.tidyverse.org'><img src='man/figures/logo.png' align="right" height="139" /></a>


<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/haven)](https://cran.r-project.org/package=haven)
[![R-CMD-check](https://github.com/tidyverse/haven/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tidyverse/haven/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/tidyverse/haven/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tidyverse/haven?branch=main)
<!-- badges: end -->

## Overview

Haven enables R to read and write various data formats used by other statistical packages by wrapping the fantastic [ReadStat](https://github.com/WizardMac/ReadStat) C library written by [Evan Miller](https://www.evanmiller.org). Haven is part of the [tidyverse](https://www.tidyverse.org/). Currently it supports:

* __SAS__: `read_sas()` reads `.sas7bdat` + `.sas7bcat` files and `read_xpt()` 
  reads SAS transport files (versions 5 and 8). `write_xpt()` writes SAS
  transport files (versions 5 and 8).
  
* __SPSS__: `read_sav()` reads `.sav` files and `read_por()` reads the 
  older `.por` files. `write_sav()` writes `.sav` files.
  
* __Stata__: `read_dta()` reads `.dta` files (up to version 15). 
  `write_dta()` writes `.dta` files (versions 8-15).

The output objects:

* Are [tibbles](https://github.com/tidyverse/tibble), which have a better print
  method for very long and very wide files.
  
* Translate value labels into a new `labelled()` class, which preserves the
  original semantics and can easily be coerced to factors with `as_factor()`.
  Special missing values are preserved. See `vignette("semantics")` for 
  more details.

* Dates and times are converted to R date/time classes. Character vectors are
  not converted to factors.
  
## Installation

```{r, eval = FALSE}
# The easiest way to get haven is to install the whole tidyverse:
install.packages("tidyverse")

# Alternatively, install just haven:
install.packages("haven")
```

## Usage

```{r, eval = FALSE}
library(haven)

# SAS
read_sas("mtcars.sas7bdat")
write_xpt(mtcars, "mtcars.xpt")

# SPSS
read_sav("mtcars.sav")
write_sav(mtcars, "mtcars.sav")

# Stata
read_dta("mtcars.dta")
write_dta(mtcars, "mtcars.dta")
```

## Related work

* [foreign](https://cran.r-project.org/package=foreign) reads from 
  SAS XPORT, SPSS, and Stata (up to version 12) files.

* [readstat13](https://cran.r-project.org/package=readstata13) reads from 
  and writes to all Stata file format versions.

* [sas7bdat](https://cran.r-project.org/package=sas7bdat) reads from
  SAS7BDAT files.

## Code of Conduct

Please note that the haven project is released with a [Contributor Code of Conduct](https://haven.tidyverse.org/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.