https://github.com/queryverse/featherlib.jl

Low level Julia library for reading feather files
https://github.com/queryverse/featherlib.jl

julia queryverse

Last synced: about 1 month ago
JSON representation

Low level Julia library for reading feather files

• Host: GitHub
• URL: https://github.com/queryverse/featherlib.jl
• Owner: queryverse
• License: other
• Created: 2018-03-12T04:49:18.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-08-22T06:41:53.000Z (about 4 years ago)
• Last Synced: 2024-10-14T16:41:33.436Z (about 1 month ago)
• Topics: julia, queryverse
• Language: Julia
• Homepage:
• Size: 483 KB
• Stars: 4
• Watchers: 3
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# FeatherLib

[![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)

[![Build Status](https://travis-ci.org/queryverse/FeatherLib.jl.svg?branch=master)](https://travis-ci.org/queryverse/FeatherLib.jl)

[![Build status](https://ci.appveyor.com/api/projects/status/wam48ho02aekt3gu/branch/master?svg=true)](https://ci.appveyor.com/project/queryverse/featherlib-jl/branch/master)

[![codecov](https://codecov.io/gh/queryverse/FeatherLib.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/queryverse/FeatherLib.jl)

## 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](https://github.com/queryverse/FeatherFiles.jl) or [Feather.jl](https://github.com/JuliaData/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:

````julia

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:

````julia

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 ``Symbol``s with the column names.

## Acknowledgements

[Douglas Bates](https://github.com/dmbates), [ExpandingMan](https://github.com/ExpandingMan) and [Jacob Quinn](https://github.com/quinnj) deserve most of the credit for the code in this package: their code in the [Feather.jl](https://github.com/JuliaData/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.