The teddy Reference Manual

This is the teddy Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 07:02:56 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 teddy

A data framework for Common Lisp, wanna be like Pandas for Python.

Author

Alexander Artemenko <>

License

UNLICENSE

Defsystem Dependency

asdf-finalizers (system).

Dependencies
Source

teddy.asd.


2.2 teddy/data-frame

Author

Alexander Artemenko <>

License

UNLICENSE

Dependencies
  • cl-ascii-table (system).
  • hu.dwim.def (system).
  • list-of (system).
  • rutils (system).
  • alexandria (system).
  • simplified-types (system).
  • teddy/utils (system).
Source

teddy.asd.


2.3 teddy/utils

Author

Alexander Artemenko <>

License

UNLICENSE

Dependencies
  • hu.dwim.def (system).
  • simplified-types (system).
Source

teddy.asd.


2.4 teddy/index

Author

Alexander Artemenko <>

License

UNLICENSE

Dependencies
  • eazy-gnuplot (system).
  • hu.dwim.def (system).
  • rutils (system).
  • teddy/data-frame (system).
Source

teddy.asd.


2.5 teddy/stats

Author

Alexander Artemenko <>

License

UNLICENSE

Dependencies
  • lhstats (system).
  • hu.dwim.def (system).
  • rutils (system).
  • teddy/data-frame (system).
Source

teddy.asd.


2.6 teddy/print

Author

Alexander Artemenko <>

License

UNLICENSE

Dependencies
  • cl-ascii-table (system).
  • hu.dwim.def (system).
  • rutils (system).
  • teddy/utils (system).
Source

teddy.asd.


2.7 teddy/plot

Author

Alexander Artemenko <>

License

UNLICENSE

Dependencies
  • eazy-gnuplot (system).
  • hu.dwim.def (system).
  • teddy/data-frame (system).
  • alexandria (system).
Source

teddy.asd.


3 Files

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


3.1 Lisp


3.1.1 teddy/teddy.asd

Source

teddy.asd.

Parent Component

teddy (system).

ASDF Systems

3.1.2 teddy/data-frame/file-type.lisp

Source

teddy.asd.

Parent Component

teddy/data-frame (system).

Public Interface
Internals

3.1.3 teddy/utils/file-type.lisp

Source

teddy.asd.

Parent Component

teddy/utils (system).

Packages

teddy/utils.

Internals

3.1.4 teddy/index/file-type.lisp

Source

teddy.asd.

Parent Component

teddy/index (system).

Packages

teddy/index.

Public Interface
Internals

3.1.5 teddy/stats/file-type.lisp

Source

teddy.asd.

Parent Component

teddy/stats (system).

Packages

teddy/stats.

Public Interface

stats (function).


3.1.6 teddy/print/file-type.lisp

Source

teddy.asd.

Parent Component

teddy/print (system).

Packages

teddy/data-frame.

Public Interface
Internals

make-value-formatter (function).


3.1.7 teddy/plot/file-type.lisp

Source

teddy.asd.

Parent Component

teddy/plot (system).

Packages

teddy/plot.

Public Interface
Internals

filename->terminal (function).


4 Packages

Packages are listed by definition order.


4.1 teddy/stats

Source

file-type.lisp.

Use List

common-lisp.

Public Interface

stats (function).


4.2 teddy/plot

Source

file-type.lisp.

Use List

common-lisp.

Public Interface
Internals

filename->terminal (function).


4.3 teddy/index

Source

file-type.lisp.

Use List

common-lisp.

Public Interface
Internals

4.4 teddy/data-frame

Source

file-type.lisp.

Use List

common-lisp.

Public Interface
Internals

4.5 teddy/utils

Source

file-type.lisp.

Use List

common-lisp.

Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: column-idx (data-frame name)

Returns a number of the column

Package

teddy/data-frame.

Source

file-type.lisp.

Function: make-index (data-frame column)
Package

teddy/index.

Source

file-type.lisp.

Function: make-iterator (data-frame)

Returns a function from zero arguments which will return a next row on each call. When all rows will be returned, iterator will return nil.

Rows are returned as lists.

Package

teddy/data-frame.

Source

file-type.lisp.

Function: plot (data-frame filename &key title debug)
Package

teddy/plot.

Source

file-type.lisp.

Function: plot-timeseries (dataframe filename &key x y title)

Plots a timeseries where axis x has a timestamp values.
If column for axis y is not given, then second column will be used.

Package

teddy/plot.

Source

file-type.lisp.

Function: set-num-digits-after-point (num)
Package

teddy/data-frame.

Source

file-type.lisp.

Function: stats (data-frame)

Returns a new dataframe where each column holds different stats on corresponding columns from original data-frame.

Package

teddy/stats.

Source

file-type.lisp.


5.1.2 Generic functions

Generic Reader: get-columns (object)
Package

teddy/data-frame.

Methods
Reader Method: get-columns ((data-frame data-frame))

A vector of column vectors

Source

file-type.lisp.

Target Slot

columns.

Generic Function: scalar (index value column-name)
Package

teddy/index.

Methods
Method: scalar ((index index) value column-name)

Returns a cell content corresponding to the value and column-name.

Source

file-type.lisp.

Generic Function: scalar (obj row-idx column-name)

Returns a cell content corresponding to the row-idx and column-name.

Package

teddy/data-frame.

Source

file-type.lisp.

Methods
Method: scalar ((data-frame data-frame) row-idx column-name)

Returns a cell content corresponding to the row-idx and column-name.


5.1.3 Standalone methods

Method: print-object ((data-frame data-frame) stream)
Source

file-type.lisp.


5.1.4 Classes

Class: data-frame
Package

teddy/data-frame.

Source

file-type.lisp.

Direct methods
Direct slots
Slot: names

Column names

Type

(simple-array string (*))

Initargs

:names

Readers

get-column-names.

Writers

This slot is read-only.

Slot: types

A list of columns

Type

simple-vector

Initargs

:types

Readers

get-types.

Writers

This slot is read-only.

Slot: columns

A vector of column vectors

Type

(simple-array simple-vector (*))

Initargs

:columns

Readers

get-columns.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Ordinary functions

Function: ensure-vector (obj &key element-type)
Package

teddy/utils.

Source

file-type.lisp.

Function: filename->terminal (filename)

Transforms string or pathname into a list suitable for passing as :terminal value to eazy-gnuplot:gp-setup.

Package

teddy/plot.

Source

file-type.lisp.

Function: get-column (data-frame name &key as)

Returns column by name

Package

teddy/data-frame.

Source

file-type.lisp.

Function: head (data-frame &optional rows)
Package

teddy/data-frame.

Source

file-type.lisp.

Function: infer-type (value)
Package

teddy/utils.

Source

file-type.lisp.

Function: make-data-frame (column-names &key rows columns types)
Package

teddy/data-frame.

Source

file-type.lisp.

Function: make-value-formatter (num-digits-after-point)
Package

teddy/data-frame.

Source

file-type.lisp.

Function: num-columns (data-frame)
Package

teddy/data-frame.

Source

file-type.lisp.

Function: num-rows (data-frame)
Package

teddy/data-frame.

Source

file-type.lisp.

Function: row-index (index value)

Internal function to getting the row index by the value.

Package

teddy/index.

Source

file-type.lisp.

Function: slice (data-frame &key columns from to)
Package

teddy/data-frame.

Source

file-type.lisp.

Function: tail (data-frame &optional rows)
Package

teddy/data-frame.

Source

file-type.lisp.

Function: vector-to-list (vector)
Package

teddy/utils.

Source

file-type.lisp.


5.2.2 Generic functions

Generic Reader: get-column-names (object)
Package

teddy/data-frame.

Methods
Reader Method: get-column-names ((data-frame data-frame))

Column names

Source

file-type.lisp.

Target Slot

names.

Generic Reader: get-types (object)
Package

teddy/data-frame.

Methods
Reader Method: get-types ((data-frame data-frame))

A list of columns

Source

file-type.lisp.

Target Slot

types.

Generic Reader: index-column (object)
Package

teddy/index.

Methods
Reader Method: index-column ((index index))

automatically generated reader method

Source

file-type.lisp.

Target Slot

column.

Generic Reader: index-data-frame (object)
Package

teddy/index.

Methods
Reader Method: index-data-frame ((index index))

automatically generated reader method

Source

file-type.lisp.

Target Slot

data-frame.

Generic Reader: index-positions (object)
Package

teddy/index.

Methods
Reader Method: index-positions ((index index))

automatically generated reader method

Source

file-type.lisp.

Target Slot

positions.


5.2.3 Classes

Class: index
Package

teddy/index.

Source

file-type.lisp.

Direct methods
Direct slots
Slot: data-frame
Package

teddy/data-frame.

Type

teddy/data-frame:data-frame

Initargs

:data-frame

Readers

index-data-frame.

Writers

This slot is read-only.

Slot: column
Initargs

:column

Readers

index-column.

Writers

This slot is read-only.

Slot: positions
Type

hash-table

Initform

(make-hash-table :test (quote equal))

Readers

index-positions.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   C   E   F   G   H   I   M   N   P   R   S   T   V  
Index Entry  Section

C
column-idx: Public ordinary functions

E
ensure-vector: Private ordinary functions

F
filename->terminal: Private ordinary functions
Function, column-idx: Public ordinary functions
Function, ensure-vector: Private ordinary functions
Function, filename->terminal: Private ordinary functions
Function, get-column: Private ordinary functions
Function, head: Private ordinary functions
Function, infer-type: Private ordinary functions
Function, make-data-frame: Private ordinary functions
Function, make-index: Public ordinary functions
Function, make-iterator: Public ordinary functions
Function, make-value-formatter: Private ordinary functions
Function, num-columns: Private ordinary functions
Function, num-rows: Private ordinary functions
Function, plot: Public ordinary functions
Function, plot-timeseries: Public ordinary functions
Function, row-index: Private ordinary functions
Function, set-num-digits-after-point: Public ordinary functions
Function, slice: Private ordinary functions
Function, stats: Public ordinary functions
Function, tail: Private ordinary functions
Function, vector-to-list: Private ordinary functions

G
Generic Function, get-column-names: Private generic functions
Generic Function, get-columns: Public generic functions
Generic Function, get-types: Private generic functions
Generic Function, index-column: Private generic functions
Generic Function, index-data-frame: Private generic functions
Generic Function, index-positions: Private generic functions
Generic Function, scalar: Public generic functions
Generic Function, scalar: Public generic functions
get-column: Private ordinary functions
get-column-names: Private generic functions
get-column-names: Private generic functions
get-columns: Public generic functions
get-columns: Public generic functions
get-types: Private generic functions
get-types: Private generic functions

H
head: Private ordinary functions

I
index-column: Private generic functions
index-column: Private generic functions
index-data-frame: Private generic functions
index-data-frame: Private generic functions
index-positions: Private generic functions
index-positions: Private generic functions
infer-type: Private ordinary functions

M
make-data-frame: Private ordinary functions
make-index: Public ordinary functions
make-iterator: Public ordinary functions
make-value-formatter: Private ordinary functions
Method, get-column-names: Private generic functions
Method, get-columns: Public generic functions
Method, get-types: Private generic functions
Method, index-column: Private generic functions
Method, index-data-frame: Private generic functions
Method, index-positions: Private generic functions
Method, print-object: Public standalone methods
Method, scalar: Public generic functions
Method, scalar: Public generic functions

N
num-columns: Private ordinary functions
num-rows: Private ordinary functions

P
plot: Public ordinary functions
plot-timeseries: Public ordinary functions
print-object: Public standalone methods

R
row-index: Private ordinary functions

S
scalar: Public generic functions
scalar: Public generic functions
scalar: Public generic functions
scalar: Public generic functions
set-num-digits-after-point: Public ordinary functions
slice: Private ordinary functions
stats: Public ordinary functions

T
tail: Private ordinary functions

V
vector-to-list: Private ordinary functions


A.4 Data types

Jump to:   C   D   F   I   P   S   T  
Index Entry  Section

C
Class, data-frame: Public classes
Class, index: Private classes

D
data-frame: Public classes

F
File, file-type.lisp: The teddy/data-frame/file-type․lisp file
File, file-type.lisp: The teddy/utils/file-type․lisp file
File, file-type.lisp: The teddy/index/file-type․lisp file
File, file-type.lisp: The teddy/stats/file-type․lisp file
File, file-type.lisp: The teddy/print/file-type․lisp file
File, file-type.lisp: The teddy/plot/file-type․lisp file
File, teddy.asd: The teddy/teddy․asd file
file-type.lisp: The teddy/data-frame/file-type․lisp file
file-type.lisp: The teddy/utils/file-type․lisp file
file-type.lisp: The teddy/index/file-type․lisp file
file-type.lisp: The teddy/stats/file-type․lisp file
file-type.lisp: The teddy/print/file-type․lisp file
file-type.lisp: The teddy/plot/file-type․lisp file

I
index: Private classes

P
Package, teddy/data-frame: The teddy/data-frame package
Package, teddy/index: The teddy/index package
Package, teddy/plot: The teddy/plot package
Package, teddy/stats: The teddy/stats package
Package, teddy/utils: The teddy/utils package

S
System, teddy: The teddy system
System, teddy/data-frame: The teddy/data-frame system
System, teddy/index: The teddy/index system
System, teddy/plot: The teddy/plot system
System, teddy/print: The teddy/print system
System, teddy/stats: The teddy/stats system
System, teddy/utils: The teddy/utils system

T
teddy: The teddy system
teddy.asd: The teddy/teddy․asd file
teddy/data-frame: The teddy/data-frame system
teddy/data-frame: The teddy/data-frame package
teddy/index: The teddy/index system
teddy/index: The teddy/index package
teddy/plot: The teddy/plot system
teddy/plot: The teddy/plot package
teddy/print: The teddy/print system
teddy/stats: The teddy/stats system
teddy/stats: The teddy/stats package
teddy/utils: The teddy/utils system
teddy/utils: The teddy/utils package