Skip to content

Commit

Permalink
Tweak readme organisation
Browse files Browse the repository at this point in the history
  • Loading branch information
hadley committed Oct 28, 2016
1 parent 699b7c3 commit 43dbddb
Showing 1 changed file with 25 additions and 15 deletions.
40 changes: 25 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,31 @@

## Overview

Haven allows you to load foreign data formats (SAS, SPSS and Stata) in to R by wrapping the fantastic [ReadStat](https://github.com/WizardMac/ReadStat) C library written by [Evan Miller](http://www.evanmiller.org).

Key features:

* Reads both types of SPSS files (`.sav` and `.por`), Stata files (up to
version 14), SAS's proprietary binary format (`.sas7bdat` & `.sas7bcat`),
and SAS's open transport format (`.xpt`).

* Writes SPSS, Stata, and SAS files.

* Date times are converted to corresponding R classes and labelled vectors are
returned as a new `labelled` class. You can easily coerce to factors or
replace labelled values with missings as appropriate. All functions return
[tibbles](http://github.com/hadley/tibble).

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

* __SAS__: `read_sas()` reads `.sas7bdat` + `.sas7bcat` files and `read_xpt()`
SAS transport files (version 5 and version 8). `write_sas()` writes
`.sas7bdat` files.

* __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 14).
`write_dta()` writes `.dta` files (versions 8-14).

The output objects:

* Are [tibbles](http://github.com/hadley/tibble), which have a better print
method for very long and very wide files.

* Translate value labels into a new `labelled()` class, which preserve the
original semantics and can easily coerced to factors with `as_factor()`.
Special missing values are preserved. See `vignette("semantics")` for
more details.

* Date/times are converted to R date/time classes. Character vectors are
not converted to factors.

## Installation

```R
Expand Down

0 comments on commit 43dbddb

Please sign in to comment.