Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CSV.read docs about WeakRefString conversions #118

Closed
wants to merge 3 commits into from
Closed

Update CSV.read docs about WeakRefString conversions #118

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ac116b4
Update docs
nickeubank Nov 26, 2017
baec40d
Update WeakRefString to String conversion docs
nickeubank Dec 8, 2017
aa38fd5
Avoid mentioning df (as it's not necessarily obvious what it means)
nalimilan Dec 8, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Source.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ Keyword Arguments:
* `categorical::Bool=true`: read string column as a `CategoricalArray` ([ref](https://github.com/JuliaData/CategoricalArrays.jl)), as long as the % of unique values seen during type detection is less than 67%. This will dramatically reduce memory use in cases where the number of unique values is small.

Note by default, "string" or text columns will be parsed as the [`WeakRefString`](https://github.com/quinnj/WeakRefStrings.jl) type. This is a custom type that only stores a pointer to the actual byte data + the number of bytes.
To convert a `String` to a standard Julia string type, just call `string(::WeakRefString)`, this also works on an entire column.
To convert a string column `col` to a standard Julia `String` vector, use either `convert(Array{String}, col)` or `convert(Array{Union{String, Missing}}, col)`, depending on whether the column supports `missing` values.
Oftentimes, however, it can be convenient to work with `WeakRefStrings` depending on the ultimate use, such as transfering the data directly to another system and avoiding all the intermediate copying.

Example usage:
Expand Down