dfio

2022-11-07

Common Lisp library for reading and writing data-frames

Upstream URL

github.com/Lisp-Stat/dfio

Author

Steve Nunez <steve@symbolics.tech>

License

msPl
README

Contributors Forks Stargazers Issues MS-PL License LinkedIn


Logo

Data Frame I/O

A system for file and network I/O for data frames
Explore the docs »

Report Bug · Request Feature · Reference Manual

Table of Contents

  1. About the Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Resources
  6. Contributing
  7. License
  8. Contact

About the Project

A data frame isn't much use if you have to type all the data in by hand. This system provides I/O functions to read data sets from delimited (CSV, TSV, etc.) files. File may be either on local disk or accessible from network locations.

Built With

Getting Started

To get a local copy up and running follow these steps:

Prerequisites

An ANSI Common Lisp implementation. Developed and tested with SBCL and CCL.

Getting the source

To make the system accessible to ASDF (a build facility, similar to make in the C world), clone the repository in a directory ASDF knows about. By default the common-lisp directory in your home directory is known. Create this if it doesn't already exist and then:

  1. Clone the repository
cd ~/common-lisp && \
git clone https://github.com/Lisp-Stat/data-frame.git && \
git clone https://github.com/Lisp-Stat/dfio.git
  1. Reset the ASDF source-registry to find the new system (from the REPL)
    (asdf:clear-source-registry)
  2. Load the system
    (asdf:load-system :dfio)

If you have installed the slime ASDF extensions, you can invoke this with a comma (',') from the slime REPL.

Getting dependencies

To get the third party systems that DFIO depends on, you can use a dependency manager, such as Quicklisp or CLPM Once installed, get the dependencies with either of:

(clpm-client:sync :sources "clpi") ;sources may vary
(ql:quickload :lisp-stat)

You need do this only once. After obtaining the dependencies, you can load the system with ASDF as described above without first syncing sources.

Usage

Create a data frame from a file named sg-weather.csv on the local disk:

(defparameter *df*
	(read-csv #P"LS:DATASETS;sg-weather.csv"))

For more examples, refer to the Documentation.

Roadmap

See the open issues for a list of proposed features (and known issues).

Resources

This system is part of the Lisp-Stat project; that should be your first stop for information. Also see the community page for more information.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. Please see CONTRIBUTING for details on the code of conduct, and the process for submitting pull requests.

License

Distributed under the MS-PL License. See LICENSE for more information.

Contact

Project Link: https://github.com/lisp-stat/dfio

Dependencies (7)

  • alexandria
  • anaphora
  • clunit2
  • data-frame
  • dexador
  • fare-csv
  • let-plus

Dependents (2)

  • GitHub
  • Quicklisp