Skip to content

Commit 5145f3d

Browse files
Update index.md (#966)
1 parent 61f8891 commit 5145f3d

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/src/index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@ GitHub Repo: [https://github.com/JuliaData/CSV.jl](https://github.com/JuliaData/
44

55
Welcome to CSV.jl! A pure-Julia package for handling delimited text data, be it comma-delimited (csv), tab-delimited (tsv), or otherwise.
66

7+
## Installation
8+
9+
You can install CSV by typing the following in the Julia REPL:
10+
```julia
11+
] add CSV
12+
```
13+
14+
followed by
15+
```julia
16+
using CSV
17+
```
18+
to load the package.
19+
20+
## Overview
21+
722
To start out, let's discuss the high-level functionality provided by the package, which hopefully will help direct you to more specific documentation for your use-case:
823

924
* [`CSV.File`](@ref): the most commonly used function for ingesting delimited data; will read an entire data input or vector of data inputs, detecting number of columns and rows, along with the type of data for each column. Returns a `CSV.File` object, which is like a lightweight table/DataFrame. Assuming `file` is a variable of a `CSV.File` object, individual columns can be accessed like `file.col1`, `file[:col1]`, or `file["col"]`. You can see parsed column names via `file.names`. A `CSV.File` can also be iterated, where a `CSV.Row` is produced on each iteration, which allows access to each value in the row via `row.col1`, `row[:col1]`, or `row[1]`. You can also index a `CSV.File` directly, like `file[1]` to return the entire `CSV.Row` at the provided index/row number. Multiple threads will be used while parsing the input data if the input is large enough, and full return column buffers to hold the parsed data will be allocated. `CSV.File` satisfies the [Tables.jl](https://github.com/JuliaData/Tables.jl) "source" interface, and so can be passed to valid sink functions like `DataFrame`, `SQLite.load!`, `Arrow.write`, etc. Supports a number of keyword arguments to control parsing, column type, and other file metadata options.

0 commit comments

Comments
 (0)