Low level Julia library for reading feather files
Branch: master
Clone or download
Latest commit 445b3c4 Jan 16, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Fix a method ambiguity on julia 1.1 Jan 16, 2019
test Fix 0.7 compat issue Aug 25, 2018
.gitignore Clean .gitignore Mar 12, 2018
.travis.yml Update CI config for julia 1.1 Jan 3, 2019
CONTRIBUTING.md Add CONTRIBUTING file May 6, 2018
LICENSE.md Update LICENSE May 6, 2018
NEWS.md Update NEWS Jan 16, 2019
README.md Update README Aug 25, 2018
REQUIRE Update REQUIRE for julia 1.0 Aug 25, 2018
appveyor.yml Update CI config for julia 1.1 Jan 3, 2019

README.md

FeatherLib

Project Status: Active - The project has reached a stable, usable state and is being actively developed. Build Status Build status FeatherLib codecov

Overview

This is a low level package to read feather files. It is not meant to be used by end users, but rather as a building block for other packages that expose user friendly APIs for file IO.

End users are encouraged to use either FeatherFiles.jl or Feather.jl to interact with feather files.

Getting Started

The package exports two functions: featherread and featherwrite.

Use the featherread function to read a feather file:

data = featherread("testfile.feather")

data will then be of type ResultSet. The field columns is a vector of vectors and holds the actual data columns. The field names returns the names of the columns. The description and metadata fields return additional data from the feather file.

Use the featherwrite function to write a feather file:

featherwrite("testfile.feather", column_data, column_names)

columns should be a vector of vectors that holds the data to be written. column_names should be a vector of Symbols with the column names.

Acknowledgements

Douglas Bates, ExpandingMan and Jacob Quinn deserve most of the credit for the code in this package: their code in the Feather.jl package was the starting point for this package here. They are of course not responsible for any errors introduced by myself in this package here.