The vellum-csv Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The vellum-csv Reference Manual

This is the vellum-csv Reference Manual, version 0.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Oct 13 13:00:31 2021 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

# vellum-csv

This system adds a basic support for reading tables from and writing tables to csv files.

#+BEGIN_SRC common-lisp
  (defparameter *table*
    (vellum:copy-from :csv "~/csv.csv"
                      :includes-header-p t
                      :columns '(a b)))
#+END_SRC

#+BEGIN_SRC common-lisp
  (vellum:copy-to :csv "~/output.csv" *table* )
#+END_SRC

Strings are automaticly converted to values, depending on the :TYPE of the column. Only numbers and strings are supported at this point though. Additional types can be supported by specializing FROM-STRING and TO-STRING generic functions.

This system is implemented by the means of the CSV-RANGE. CSV-RANGE can be used on it's own to aggregate CSV files that are unsuitable for putting in to the table. Example of these are a very large files, that are unlikely to fit into the main memory. Using reservoir sampling or data sketch techniques (available in CL-DS) can be favored in those situations. Furthermore, instead of passing path to the CSV file, it is actually possible to use this system with an cl-ds range, as long as it yields csv rows in the form of the string. This makes it possible to read mutliple CSV into a singular table at once, use (already mentioned) reservoir sampling techniques or integrate with UNIX system to handle tricky archive formats (XYZ for instance). The downside is that this forces user to remove CSV table headers manually.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 vellum-csv

Author

Marek Kochanowicz

License

BSD simplified

Description

CSV support for Vellum Data Frames

Version

0.0.0

Dependencies
Source

vellum-csv.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 vellum-csv.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/vellum-csv-20210807-git/vellum-csv.asd

Systems

vellum-csv (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 vellum-csv/package.lisp

Parent

vellum-csv (system)

Location

package.lisp

Packages

vellum-csv


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 vellum-csv/generics.lisp

Dependency

package.lisp (file)

Parent

vellum-csv (system)

Location

generics.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 vellum-csv/types.lisp

Dependency

generics.lisp (file)

Parent

vellum-csv (system)

Location

types.lisp

Exported Definitions

csv-range (class)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 vellum-csv/functions.lisp

Dependency

types.lisp (file)

Parent

vellum-csv (system)

Location

functions.lisp

Exported Definitions

csv-range (function)


Previous: , Up: Lisp files   [Contents][Index]

3.1.6 vellum-csv/implementation.lisp

Dependency

functions.lisp (file)

Parent

vellum-csv (system)

Location

implementation.lisp

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 vellum-csv

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: csv-range PATH/RANGE &key INCLUDES-HEADER-P HEADER SEPARATOR QUOTE
Package

vellum-csv

Source

functions.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Generic functions

Generic Function: from-string DATA-TYPE STRING
Package

vellum-csv

Source

generics.lisp (file)

Methods
Method: from-string (TYPE (eql boolean)) STRING
Source

implementation.lisp (file)

Method: from-string (TYPE (eql t)) STRING
Source

implementation.lisp (file)

Method: from-string (TYPE (eql double-float)) STRING
Source

implementation.lisp (file)

Method: from-string (TYPE (eql single-float)) STRING
Source

implementation.lisp (file)

Method: from-string (TYPE (eql float)) STRING
Source

implementation.lisp (file)

Method: from-string (TYPE (eql string)) STRING
Source

implementation.lisp (file)

Method: from-string (TYPE (eql integer)) STRING
Source

implementation.lisp (file)

Method: from-string (TYPE (eql fixnum)) STRING
Source

implementation.lisp (file)

Method: from-string (TYPE (eql number)) STRING
Source

implementation.lisp (file)

Method: from-string TYPE STRING around
Source

implementation.lisp (file)

Generic Function: to-string DATA-TYPE VALUE
Package

vellum-csv

Source

generics.lisp (file)

Methods
Method: to-string (TYPE (eql boolean)) VALUE
Source

implementation.lisp (file)

Method: to-string TYPE VALUE
Source

implementation.lisp (file)

Method: to-string TYPE VALUE around
Source

implementation.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Classes

Class: csv-range ()
Package

vellum-csv

Source

types.lisp (file)

Direct superclasses
  • forward-proxy-range (class)
  • frame-range-mixin (class)
Direct methods
Direct slots
Slot: %includes-header-p
Initargs

:includes-header-p

Readers

includes-header-p (generic function)

Slot: %separator
Initargs

:separator

Readers

separator (generic function)

Slot: %quote
Initargs

:quote

Readers

csv-quote (generic function)

Direct Default Initargs
InitargValue
:separator#\,
:quote#\"

Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Generic functions

Generic Function: csv-quote OBJECT
Package

vellum-csv

Methods
Method: csv-quote (CSV-RANGE csv-range)

automatically generated reader method

Source

types.lisp (file)

Generic Function: includes-header-p OBJECT
Package

vellum-csv

Methods
Method: includes-header-p (CSV-RANGE csv-range)

automatically generated reader method

Source

types.lisp (file)

Generic Function: separator OBJECT
Package

vellum-csv

Methods
Method: separator (CSV-RANGE csv-range)

automatically generated reader method

Source

types.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   V  
Index Entry  Section

F
File, Lisp, vellum-csv.asd: The vellum-csv․asd file
File, Lisp, vellum-csv/functions.lisp: The vellum-csv/functions․lisp file
File, Lisp, vellum-csv/generics.lisp: The vellum-csv/generics․lisp file
File, Lisp, vellum-csv/implementation.lisp: The vellum-csv/implementation․lisp file
File, Lisp, vellum-csv/package.lisp: The vellum-csv/package․lisp file
File, Lisp, vellum-csv/types.lisp: The vellum-csv/types․lisp file

L
Lisp File, vellum-csv.asd: The vellum-csv․asd file
Lisp File, vellum-csv/functions.lisp: The vellum-csv/functions․lisp file
Lisp File, vellum-csv/generics.lisp: The vellum-csv/generics․lisp file
Lisp File, vellum-csv/implementation.lisp: The vellum-csv/implementation․lisp file
Lisp File, vellum-csv/package.lisp: The vellum-csv/package․lisp file
Lisp File, vellum-csv/types.lisp: The vellum-csv/types․lisp file

V
vellum-csv.asd: The vellum-csv․asd file
vellum-csv/functions.lisp: The vellum-csv/functions․lisp file
vellum-csv/generics.lisp: The vellum-csv/generics․lisp file
vellum-csv/implementation.lisp: The vellum-csv/implementation․lisp file
vellum-csv/package.lisp: The vellum-csv/package․lisp file
vellum-csv/types.lisp: The vellum-csv/types․lisp file

Jump to:   F   L   V  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   C   F   G   I   M   S   T  
Index Entry  Section

C
csv-quote: Internal generic functions
csv-quote: Internal generic functions
csv-range: Exported functions

F
from-string: Exported generic functions
from-string: Exported generic functions
from-string: Exported generic functions
from-string: Exported generic functions
from-string: Exported generic functions
from-string: Exported generic functions
from-string: Exported generic functions
from-string: Exported generic functions
from-string: Exported generic functions
from-string: Exported generic functions
from-string: Exported generic functions
Function, csv-range: Exported functions

G
Generic Function, csv-quote: Internal generic functions
Generic Function, from-string: Exported generic functions
Generic Function, includes-header-p: Internal generic functions
Generic Function, separator: Internal generic functions
Generic Function, to-string: Exported generic functions

I
includes-header-p: Internal generic functions
includes-header-p: Internal generic functions

M
Method, csv-quote: Internal generic functions
Method, from-string: Exported generic functions
Method, from-string: Exported generic functions
Method, from-string: Exported generic functions
Method, from-string: Exported generic functions
Method, from-string: Exported generic functions
Method, from-string: Exported generic functions
Method, from-string: Exported generic functions
Method, from-string: Exported generic functions
Method, from-string: Exported generic functions
Method, from-string: Exported generic functions
Method, includes-header-p: Internal generic functions
Method, separator: Internal generic functions
Method, to-string: Exported generic functions
Method, to-string: Exported generic functions
Method, to-string: Exported generic functions

S
separator: Internal generic functions
separator: Internal generic functions

T
to-string: Exported generic functions
to-string: Exported generic functions
to-string: Exported generic functions
to-string: Exported generic functions

Jump to:   C   F   G   I   M   S   T  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   %  
S  
Index Entry  Section

%
%includes-header-p: Exported classes
%quote: Exported classes
%separator: Exported classes

S
Slot, %includes-header-p: Exported classes
Slot, %quote: Exported classes
Slot, %separator: Exported classes

Jump to:   %  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S   V  
Index Entry  Section

C
Class, csv-range: Exported classes
csv-range: Exported classes

P
Package, vellum-csv: The vellum-csv package

S
System, vellum-csv: The vellum-csv system

V
vellum-csv: The vellum-csv system
vellum-csv: The vellum-csv package

Jump to:   C   P   S   V