Skip to content

Commit

Permalink
More descriptions on reference page
Browse files Browse the repository at this point in the history
  • Loading branch information
hadley committed Oct 28, 2016
1 parent 579d2ec commit 0c4c10b
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 16 deletions.
26 changes: 18 additions & 8 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,22 @@ navbar:

reference:
- title: Read rectangular files
desc: >
These functions parse rectangular files (like csv or fixed-width format)
into tibbles. They specify the overall structure of the file, and how each
line is divided up into fields.
contents:
- read_delim
- read_fwf
- read_log
- read_table

- title: Column specification
desc: >
The column specification describes how each column is parsed from a
character vector in to a more specific data type. readr does make
an educated guess about the type of each column, but you'll need override
those guesses when it gets them wrong.
contents:
- problems
- cols
Expand All @@ -50,7 +59,8 @@ reference:

- title: Column parsers
desc: >
Each parser comes in two forms: `parse_xxx()` which is used to parse
Column parsers define how a single column is parsed, or a parse a single
vector. Each parser comes in two forms: `parse_xxx()` which is used to parse
vectors that already exist in R and `col_xxx()` which is used to parse
vectors as they are loaded by a `read_xxx()` function.
contents:
Expand All @@ -64,28 +74,28 @@ reference:
- title: Locale controls
desc: >
The "locale" controls all options that vary from country-to-country or
language-to-language. See `vignette("locales")` for more details.
language-to-language. This includes things like the character used as
the decimal mark, the names of days of the week, and the encoding. See
`vignette("locales")` for more details.
contents:
- locale
- date_names

- title: Write rectangular files
desc: >
Despite its name, readr also provides a number of functions to __write__
data frames to disk, and to convert them to in-memory strings.
data frames to disk, or to convert them to in-memory strings.
contents:
- starts_with("format_")
- format_csv
- write_csv

- title: Low-level IO and debugging tools
desc: >
These functions can be used with non-rectangular files, and to help
debug rectangular files that fail to parse.
These functions can be used with non-rectangular files, binary data,
and to help debug rectangular files that fail to parse.
contents:
- read_file
- read_lines
- write_file
- write_lines
- count_fields
- guess_encoding
- type_convert
Expand Down
36 changes: 28 additions & 8 deletions docs/reference/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 0c4c10b

Please sign in to comment.