_pkgdown.yml

url: https://readr.tidyverse.org

template:
  package: tidytemplate

authors:
  "Jim Hester":
    href: http://jimhester.com

development:
  mode: auto

home:
  strip_header: true
  links:
  - text: Learn more
    href: http://r4ds.had.co.nz/data-import.html

navbar:
  type: default
  left:
  - text: Home
    href: index.html
  - text: Overview
    href: articles/readr.html
  - text: Locales
    href: articles/locales.html
  - text: Reference
    href: reference/index.html
  - text: News
    menu:
    - text: "Release notes"
    - text: "Version 1.0.0"
      href: articles/releases/readr-1.0.0.html
    - text: "Version 0.2.0"
      href: articles/releases/readr-0.2.0.html
    - text: "Version 0.1.0"
      href: articles/releases/readr-0.1.0.html
    - text: "------------------"
    - text: "Change log"
      href: news/index.html


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: Read non-rectangular files
  desc: >
    These functions parse non-rectangular files (like csv or fixed-width format)
    into long (so-called melted) format. They specify the overall structure of
    the file, and how each line is divided up into fields.
  contents:
  - melt_delim
  - melt_fwf
  - melt_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
  - cols_condense
  - spec_delim

- title: Column parsers
  desc: >
    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:
  - parse_character
  - parse_datetime
  - parse_factor
  - parse_guess
  - parse_number
  - col_skip

- title: Locale controls
  desc: >
    The "locale" controls all options that vary from country-to-country or
    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, or to convert them to in-memory strings.
  contents:
  - format_csv
  - write_csv

- title: Low-level IO and debugging tools
  desc: >
    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
  - count_fields
  - guess_encoding
  - type_convert
  - readr_example
  - clipboard
  - show_progress

- title: Chunked API
  desc: >
    The chunked API allows you to read in files that are larger than memory,
    processing a chunk at a time. The API experimental: please try it out but
    be aware that it may change in the future.
  contents:
  - callback
  - read_delim_chunked
  - melt_delim_chunked
  - read_lines_chunked