The data-frame Reference Manual

This is the data-frame Reference Manual, version 1.3.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 05:00:15 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 data-frame

A data manipulation library for statistical computing

Long Name

Data frames for Common Lisp

Author

Steve Nunez <>

Home Page

https://lisp-stat.dev/docs/manuals/data-frame

Source Control

(GIT https://github.com/Lisp-Stat/data-frame.git)

Bug Tracker

https://github.com/Lisp-Stat/data-frame/issues

License

MS-PL

Long Description

A data frame is a common way of storing data for statistical analysis. Under the hood, a data frame is a vector of equal-length vectors. Each element of the vector can be thought of as a column and the length of each element of the vector is the number of rows. As a result, data frames can store different classes of objects in each column (i.e. numeric, character, factor). In essence, the easiest way to think of a data frame is as an Excel worksheet that contains columns of different types of data but are all of equal length rows.

From a design perspective, Lisp-Stat’s data frame is conceptually most similar to the ’tibble’ from the tidyverse, but using Common Lisp idioms, style and syntax.

Version

1.3.1

Dependencies
  • alexandria (system).
  • alexandria+ (system).
  • anaphora (system).
  • array-operations (system).
  • num-utils (system).
  • select (system).
  • statistics (system).
  • let-plus (system).
  • duologue (system).
  • sb-cltl2 (system).
Source

data-frame.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 data-frame/data-frame.asd

Source

data-frame.asd.

Parent Component

data-frame (system).

ASDF Systems

data-frame.


3.1.2 data-frame/pkgdcl.lisp

Source

data-frame.asd.

Parent Component

data-frame (system).

Packages

data-frame.


3.1.3 data-frame/utils.lisp

Dependency

pkgdcl.lisp (file).

Source

data-frame.asd.

Parent Component

data-frame (system).

Public Interface
Internals

3.1.4 data-frame/data-frame.lisp

Dependency

utils.lisp (file).

Source

data-frame.asd.

Parent Component

data-frame (system).

Public Interface
Internals

3.1.5 data-frame/pprint.lisp

Dependency

data-frame.lisp (file).

Source

data-frame.asd.

Parent Component

data-frame (system).

Public Interface
Internals

3.1.6 data-frame/formatted-output.lisp

Dependency

pprint.lisp (file).

Source

data-frame.asd.

Parent Component

data-frame (system).

Public Interface
Internals

3.1.7 data-frame/summary.lisp

Dependency

formatted-output.lisp (file).

Source

data-frame.asd.

Parent Component

data-frame (system).

Public Interface
Internals

3.1.8 data-frame/defdf.lisp

Dependency

summary.lisp (file).

Source

data-frame.asd.

Parent Component

data-frame (system).

Public Interface
Internals

3.1.9 data-frame/conditions.lisp

Dependency

defdf.lisp (file).

Source

data-frame.asd.

Parent Component

data-frame (system).

Public Interface
Internals

3.1.10 data-frame/properties.lisp

Dependency

conditions.lisp (file).

Source

data-frame.asd.

Parent Component

data-frame (system).

Public Interface
Internals

show-properties (function).


3.1.11 data-frame/missing.lisp

Dependency

properties.lisp (file).

Source

data-frame.asd.

Parent Component

data-frame (system).

Public Interface
Internals

drop-na (function).


3.1.12 data-frame/filter.lisp

Dependency

missing.lisp (file).

Source

data-frame.asd.

Parent Component

data-frame (system).

Public Interface

filter-rows (function).

Internals

key-list (function).


3.1.13 data-frame/plist-aops.lisp

Dependency

filter.lisp (file).

Source

data-frame.asd.

Parent Component

data-frame (system).

Internals

ensure-plist (macro).


4 Packages

Packages are listed by definition order.


4.1 data-frame

Source

pkgdcl.lisp.

Nickname

df

Use List
  • alexandria.
  • alexandria+.
  • anaphora.
  • common-lisp.
  • let-plus.
  • select.
  • select-dev.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *ask-on-redefine*

If non-nil, the system will ask the user for confirmation before redefining a data frame

Package

data-frame.

Source

defdf.lisp.

Special Variable: *distinct-maximum*

If a string/factor variable has > *distinct-maximum* values, exclude it

Package

data-frame.

Source

summary.lisp.

Special Variable: *distinct-threshold*

If an integer variable has <= discrete values, consider it a factor

Package

data-frame.

Source

summary.lisp.

Special Variable: *large-data*

An indication that the data set is large for a particular use case.
This should be bound by a user to the maximum number of data points they consider to be ’normal’. The function can then signal a large-data warning if it is exceeded.

E.g. (let ((df:*large-data* 50000))
(handler-bind ((large-data ...
(some-data-operation ; this will signal if the data is too large
(restart-bind ...

Package

data-frame.

Source

data-frame.lisp.

Special Variable: *quantile-threshold*

If the number of unique reals exceeds this threshold, they will be summarized with quantiles, otherwise print frequency table

Package

data-frame.

Source

summary.lisp.

Special Variable: *summary-minimum-length*

Columns are only summarised when longer than this, otherwise they are returned as is.

Package

data-frame.

Source

summary.lisp.


5.1.2 Macros

Macro: defdf (name data &optional documentation)

Define a data-frame and package by the same name.
Also defines symbol-macros for variable access, e.g. mtcars:mpg

Package

data-frame.

Source

defdf.lisp.

Macro: delete-nth* (place n)

Destructively modifies N, a SEQUENCE by removing the Nth item. Example:
LS-USER> (defparameter *v* #(a b c d))
*V*
LS-USER> (delete-nth* *v* 1)
#(A C D)
LS-USER> *v*
#(A C D)

Package

data-frame.

Source

utils.lisp.


5.1.3 Ordinary functions

Function: add-column! (data key column &optional update-env)

Modify DATA (a data-frame or data-vector) by adding COLUMN with KEY. Return DATA.

Package

data-frame.

Source

data-frame.lisp.

Function: add-columns (data &rest keys-and-columns)

Return a new data-frame or data-vector with keys and columns added. Does not modify DATA.

Package

data-frame.

Source

data-frame.lisp.

Function: add-columns! (data &rest keys-and-columns)

Modify DATA (a data-frame or data-vector) by adding columns with keys. If a data-frame environment exists, add columns to it as well.

Package

data-frame.

Source

data-frame.lisp.

Function: alist-df (alist)
Package

data-frame.

Source

data-frame.lisp.

Function: alist-dv (alist)
Package

data-frame.

Source

data-frame.lisp.

Function: column (data key)

Return column corresponding to key.

Package

data-frame.

Source

data-frame.lisp.

Function: (setf column) (data key)

Set column corresponding to key.

Package

data-frame.

Source

data-frame.lisp.

Function: column-names (df)

Return a list of column names in DF, as strings

Package

data-frame.

Source

data-frame.lisp.

Function: column-type (col)

Return the most specific type found in COL

Package

data-frame.

Source

utils.lisp.

Function: columns (data &optional slice)

Return the columns of DATA as a vector, or a selection if given (keys are resolved).

Package

data-frame.

Source

data-frame.lisp.

Function: copy (data &key key)

Copy data frame or vector. Keys are copied (and thus can be modified), columns or elements are copied using KEY, making the default give a shallow copy.

Package

data-frame.

Source

data-frame.lisp.

Function: count-rows (data-frame keys predicate)

Count the number of rows for which PREDICATE called on the columns corresponding to KEYS returns non-NIL.

Package

data-frame.

Source

data-frame.lisp.

Function: defdf-env (data-frame old-keys)

Create a package with the same name as DATA-FRAME. Within it, create a symbol-macro for each column that will return the columns value. Can also be used to remove and update the environment as the DATA-FRAME changes in destructive operations

Package

data-frame.

Source

defdf.lisp.

Function: delete-nth (sequence n)

Return SEQUENCE with the Nth item removed.
Note: DELETE-IF makes no guarantee of being destructive, so you cannot rely on this side-effect. You must SETF the original sequence to the values returned from this function, or use the modify-macro DELETE-NTH*

Package

data-frame.

Source

utils.lisp.

Function: df (&rest plist-or-alist)
Package

data-frame.

Source

data-frame.lisp.

Function: df-print (df)

Print DF to *standard-output* in table format

Package

data-frame.

Source

formatted-output.lisp.

Function: df-remove-duplicates (data)

Return a modified copy of DATA from which any element (row, if a DATA-FRAME) that matches another element has been removed

Package

data-frame.

Source

data-frame.lisp.

Function: do-rows (data-frame keys function)

Traverse rows from first to last, calling FUNCTION on the columns corresponding to KEYS. Return no values.

Package

data-frame.

Source

data-frame.lisp.

Function: dv (&rest plist-or-alist)
Package

data-frame.

Source

data-frame.lisp.

Function: filter-rows (data body)

Filter DATA by a predicate given in BODY

Example
(data :mtcars) ; load a data set
(head mtcars) ; view first 6 rows

;; MODEL MPG CYL DISP HP DRAT WT QSEC VS AM GEAR CARB ;; 0 Mazda RX4 21.0 6 160 110 3.90 2.620 16.46 0 1 4 4 ;; 1 Mazda RX4 Wag 21.0 6 160 110 3.90 2.875 17.02 0 1 4 4 ;; 2 Datsun 710 22.8 4 108 93 3.85 2.320 18.61 1 1 4 1 ;; 3 Hornet 4 Drive 21.4 6 258 110 3.08 3.215 19.44 1 0 3 1 ;; 4 Hornet Sportabout 18.7 8 360 175 3.15 3.440 17.02 0 0 3 2 ;; 5 Valiant 18.1 6 225 105 2.76 3.460 20.22 1 0 3 1

(filter-rows mtcars ’(< mpg 17))
#<DATA-FRAME (11 observations of 12 variables)>

(head *) ; view first 6 rows of filtered data frame

;; MODEL MPG CYL DISP HP DRAT WT QSEC VS AM GEAR CARB ;; 0 Duster 360 14.3 8 360.0 245 3.21 3.570 15.84 0 0 3 4 ;; 1 Merc 450SE 16.4 8 275.8 180 3.07 4.070 17.40 0 0 3 3 ;; 2 Merc 450SLC 15.2 8 275.8 180 3.07 3.780 18.00 0 0 3 3 ;; 3 Cadillac Fleetwood 10.4 8 472.0 205 2.93 5.250 17.98 0 0 3 4 ;; 4 Lincoln Continental 10.4 8 460.0 215 3.00 5.424 17.82 0 0 3 4 ;; 5 Chrysler Imperial 14.7 8 440.0 230 3.23 5.345 17.42 0 0 3 4

Package

data-frame.

Source

filter.lisp.

Function: get-property (variable property)

Return the PROPERTY of data VARIABLE

Package

data-frame.

Source

properties.lisp.

Function: get-summaries (df)

Return a list of summaries of the variables in DF

Package

data-frame.

Source

summary.lisp.

Function: heuristicate-types (df)

Coerce each element of the column vectors to the most specific type in the column
Often when reading in a data set, the types will be inconsistent in a variable. For example one observation might be 5.1, and another 5. Whilst mathmatically equivalent, we want our variable vectors to have identical types. The COLUMN-TYPE function returns the most specific numeric type in the column, then coerces all the vector elements to this type

Package

data-frame.

Source

properties.lisp.

Function: ignore-missing (function &key warn-user provide-restart)

Wrap FUNCTION in a closure that removes missing values and applys FUNCTION in case any of the arguments are :MISSING, :NA or NIL to arguments. Intended for functions accepting vectors.

Package

data-frame.

Source

missing.lisp.

Function: keys (data)

Return a vector of keys.

Package

data-frame.

Source

data-frame.lisp.

Function: make-df (keys columns)
Package

data-frame.

Source

data-frame.lisp.

Function: make-dv (keys columns)
Package

data-frame.

Source

data-frame.lisp.

Function: map-columns (data function &optional result-class)

Map columns of DATA-FRAME or DATA-VECTOR using FUNCTION. The result is a new DATA-FRAME with the same keys.

Package

data-frame.

Source

data-frame.lisp.

Function: map-df (data-frame keys function result-keys)

Map DATA-FRAME to another one by rows. Function is called on the columns corresponding to KEYS, and should return a sequence with the same length as RESULT-KEYS, which give the keys of the resulting data frame. RESULT-KETS should be either symbols, or of the format (symbol &optional (element-type t)).

Package

data-frame.

Source

data-frame.lisp.

Function: map-rows (data-frame keys function &key element-type)

Map rows using FUNCTION, on the columns corresponding to KEYS. Return the result with the given ELEMENT-TYPE.

Package

data-frame.

Source

data-frame.lisp.

Function: mask-rows (data-frame keys predicate)

Return a bit-vector containing the result of calling PREDICATE on rows of the columns corresponding to KEYS (0 for NIL, 1 otherwise).

Package

data-frame.

Source

data-frame.lisp.

Function: matrix-df (keys matrix)

Convert a matrix to a data-frame with the given keys.

Package

data-frame.

Source

data-frame.lisp.

Function: plist-df (plist)
Package

data-frame.

Source

data-frame.lisp.

Function: plist-dv (plist)
Package

data-frame.

Source

data-frame.lisp.

Function: print-array (arr &optional stream row-numbers-p)

Print an array to STREAM, defaulting to *standard-output*, in a tabular format. If ROW-NUMBERS-P, print row numbers.

Package

data-frame.

Source

pprint.lisp.

Function: print-data (data-frame &optional stream row-numbers-p max-digits)

Print DATA-FRAME to STREAM using the pretty printer

Package

data-frame.

Source

pprint.lisp.

Function: print-markdown (df &key stream row-numbers)

Print data frame DF, in markdown format, to STREAM
If ROW-NUMBERS is true, also print row numbers as the first column

Package

data-frame.

Source

formatted-output.lisp.

Function: remove-column! (data key)

Modify DATA (a data-frame or data-vector) by removing COLUMN with KEY. Return DATA.

Package

data-frame.

Source

data-frame.lisp.

Function: remove-columns (data keys)

Return a new data-frame or data-vector with keys and columns removed. Does not modify DATA. ARGS: DATA data frame
KEYS list of keys (variables) to be removed

Package

data-frame.

Source

data-frame.lisp.

Function: replace-column (data key function-or-column &key element-type)

Create a new data frame with new column KEY from data-frame DATA by replacing it either with the given column, or applying the function to the current values (ELEMENT-TYPE is used.)

Package

data-frame.

Source

data-frame.lisp.

Function: replace-column! (data key function-or-column &key element-type)

Modify column KEY of data-frame DATA by replacing it either with the given column, or applying the function to the current values (ELEMENT-TYPE is used.)

Package

data-frame.

Source

data-frame.lisp.

Function: rows (data)

Return the rows of DATA as a vector

Package

data-frame.

Source

data-frame.lisp.

Function: set-properties (df property prop-values)

Set the PROPERTY of each variable in DF to a value. The value is specified in the plist PROP-VALUES. Example:
To give the variables in the mtcars dataset a unit, use:
(set-properties mtcars :unit ’(:mpg m/g
:cyl :NA
:disp in³
:hp hp
:drat :NA
:wt lb
:qsec s
:vs :NA
:am :NA
:gear :NA
:carb :NA))

Package

data-frame.

Source

properties.lisp.

Function: set-property (symbol value property)

Set the PROPERTY of SYMBOL to VALUE

Package

data-frame.

Source

properties.lisp.

Function: short-string (str)

Return up to the first newline
This is useful when docstrings are multi-line. By convention, the first line is the title.

Package

data-frame.

Source

pprint.lisp.

Function: show-data-frames (&key head stream)

Print all data frames in the current environment in reverse order of creation, i.e. most recently created first. If HEAD is not NIL, print the first six rows, similar to the (head) function

Package

data-frame.

Source

defdf.lisp.

Function: summarize-column (column &optional name)

Return a summary struct for COLUMN

Package

data-frame.

Source

summary.lisp.

Function: summary (df &optional stream)

Print a summary of DF to STREAM, using heuristics for better formatting

Package

data-frame.

Source

summary.lisp.

Function: undef (&rest params)

Remove one or more data frames from the environment
PARAMS: a list of DATA-FRAMEs

Essentially reverses what DEFDF does. Returns the data frames that were removed. Don’t use this if you have a data frame bound via DEFPARAMETER. Examples:
(undef mtcars vlcars)

Package

data-frame.

Source

defdf.lisp.


5.1.4 Generic functions

Generic Reader: data-frame (condition)
Package

data-frame.

Methods
Reader Method: data-frame ((condition data-frame-exists))
Source

conditions.lisp.

Target Slot

data-frame.

Generic Function: drop-missing (df &optional predicate)
Package

data-frame.

Methods
Method: drop-missing ((var vector) &optional predicate)

Remove all values from VAR that are missing according to PREDICATE. Returns values:
1. the vector with missing values removed
2. the number of elements removed

Source

missing.lisp.

Method: drop-missing ((df data-frame) &optional predicate)

Remove all rows from DF that are missing values according to PREDICATE

Source

missing.lisp.

Generic Function: head (df &optional n)
Package

data-frame.

Methods
Method: head ((df data-frame) &optional n)

Return the first N rows of DF; N defaults to 6

Source

pprint.lisp.

Generic Function: missingp (data)

Return a vector indicating the position of any missing value indicators. They currently are :na and :missing

Package

data-frame.

Source

missing.lisp.

Methods
Method: missingp (data)
Method: missingp ((data (eql :na)))
Method: missingp ((data (eql :missing)))
Method: missingp ((data string))
Method: missingp ((data sequence))
Method: missingp ((data array))
Method: missingp ((data data-frame))
Generic Reader: name (object)
Generic Writer: (setf name) (object)
Package

data-frame.

Methods
Reader Method: name ((data data))
Writer Method: (setf name) ((data data))

The name of the data frame. MUST be the same as the symbol whose value cell points to this data frame. This slot essentially allows us to go ’backwards’ and get the symbol that names the data frame.

Source

data-frame.lisp.

Target Slot

name.

Generic Function: rename-column! (data new old)
Package

data-frame.

Methods
Method: rename-column! (data new old)

Substitute NEW, a SYMBOL, for OLD in DF

Useful when reading data files that have an empty or generated column name.

Example: (rename-column! cars ’name :||) will replace an empty symbol with ’name

Source

data-frame.lisp.

Generic Function: replace-missing (df map-alist)
Package

data-frame.

Methods
Method: replace-missing ((df data-frame) map-alist)

Replace missing values with the values specified
The alist consists of a column name in the CAR and the replacement value in the CDR Example: (replace-missing mtcarsm ’((mpg . foo)))

Source

missing.lisp.

Generic Function: tail (df &optional n)
Package

data-frame.

Methods
Method: tail ((df data-frame) &optional n)

Return the last N rows of DF; N defaults to 6

Source

pprint.lisp.


5.1.5 Standalone methods

Method: as-alist ((data data))

Key-column pairs as an alist.

Package

num-utils.utilities.

Source

data-frame.lisp.

Method: as-array ((data-vector data-vector))
Package

array-operations/generic.

Source

data-frame.lisp.

Method: as-array ((data-frame data-frame))
Package

array-operations/generic.

Source

data-frame.lisp.

Method: axis-dimension ((axis ordered-keys))
Package

select-dev.

Source

data-frame.lisp.

Method: canonical-representation ((axis ordered-keys) (slice symbol))
Package

select-dev.

Source

data-frame.lisp.

Method: describe-object ((df data-frame) stream)
Source

data-frame.lisp.

Method: dims ((data-vector data-vector))
Package

array-operations/generic.

Source

data-frame.lisp.

Method: dims ((data-frame data-frame))
Package

array-operations/generic.

Source

data-frame.lisp.

Method: element-type ((data data))
Package

array-operations/generic.

Source

data-frame.lisp.

Method: initialize-instance :after ((data-frame data-frame) &rest initargs)
Source

data-frame.lisp.

Method: ncol ((data-frame data-frame))
Package

array-operations/generic.

Source

data-frame.lisp.

Method: nrow ((data-frame data-frame))
Package

array-operations/generic.

Source

data-frame.lisp.

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

data-frame.lisp.

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

Print DATA-FRAME dimensions and type
After defining this method it is permanently associated with data-frame objects

Source

data-frame.lisp.

Method: print-object ((object real-variable-summary) stream)
Source

summary.lisp.

Method: print-object ((object bit-variable-summary) stream)
Source

summary.lisp.

Method: print-object ((object generic-variable-summary) stream)
Source

summary.lisp.

Method: print-object ((object factor-variable-summary) stream)
Source

summary.lisp.

Method: print-object ((ordered-keys ordered-keys) stream)
Source

data-frame.lisp.

Method: random-sample ((df data-frame) n &key with-replacement)

Return N rows of DF taken at random.

If WITH-REPLACEMENT is true, return a random sample with replacement (a "draw").

If WITH-REPLACEMENT is false, return a random sample without replacement (a "deal").

Package

ls.statistics.

Source

data-frame.lisp.

Method: select ((data-vector data-vector) &rest slices)
Package

select.

Source

data-frame.lisp.

Method: select ((data-frame data-frame) &rest slices)
Package

select.

Source

data-frame.lisp.

Method: select ((ordered-keys ordered-keys) &rest selections)
Package

select.

Source

data-frame.lisp.


5.1.6 Conditions

Condition: duplicate-key

An operation attempted to use a key that already exists in ORDERED-KEYS

Package

data-frame.

Source

conditions.lisp.

Direct superclasses

error.

Direct slots
Slot: key
Initargs

:key

Condition: key-not-found

An operation was attempted on a non-existant key.

Package

data-frame.

Source

conditions.lisp.

Direct superclasses

error.

Direct slots
Slot: key
Initargs

:key

Slot: keys
Initargs

:keys

Condition: large-data

A operation was requested on a data set large enough to potentially cause problems.

Package

data-frame.

Source

conditions.lisp.

Direct superclasses

warning.

Direct methods

data-size.

Direct slots
Slot: data-size
Initargs

:data-size

Readers

data-size.

Writers

This slot is read-only.


5.1.7 Structures

Structure: bit-variable-summary

Summary of a bit vector.

Package

data-frame.

Source

summary.lisp.

Direct superclasses

variable-summary%.

Direct methods

print-object.

Direct slots
Slot: count
Package

common-lisp.

Type

alexandria:array-index

Initform

0

Readers

bit-variable-summary-count.

Writers

This slot is read-only.

Structure: factor-variable-summary

Summary for factor variables

Package

data-frame.

Source

summary.lisp.

Direct superclasses

variable-summary%.

Direct methods

print-object.

Direct slots
Slot: element-count-alist
Type

list

Readers

factor-variable-summary-element-count-alist.

Writers

This slot is read-only.

Structure: generic-variable-summary

Summary for generic variables, i.e. those with mixed types.

Package

data-frame.

Source

summary.lisp.

Direct superclasses

variable-summary%.

Direct methods

print-object.

Direct slots
Slot: quantiles
Type

(or null data-frame:real-variable-summary)

Readers

generic-variable-summary-quantiles.

Writers

This slot is read-only.

Slot: element-count-alist
Type

list

Readers

generic-variable-summary-element-count-alist.

Writers

This slot is read-only.

Structure: real-variable-summary

Summary of a real elements (using quantiles).

Package

data-frame.

Source

summary.lisp.

Direct superclasses

variable-summary%.

Direct methods

print-object.

Direct slots
Slot: min
Package

common-lisp.

Type

real

Initform

0

Readers

real-variable-summary-min.

Writers

This slot is read-only.

Slot: q25
Type

real

Initform

0

Readers

real-variable-summary-q25.

Writers

This slot is read-only.

Slot: q50
Type

real

Initform

0

Readers

real-variable-summary-q50.

Writers

This slot is read-only.

Slot: mean
Package

alexandria.

Type

real

Initform

0

Readers

real-variable-summary-mean.

Writers

This slot is read-only.

Slot: q75
Type

real

Initform

0

Readers

real-variable-summary-q75.

Writers

This slot is read-only.

Slot: max
Package

common-lisp.

Type

real

Initform

0

Readers

real-variable-summary-max.

Writers

This slot is read-only.


5.1.8 Classes

Class: data-frame
Package

data-frame.

Source

data-frame.lisp.

Direct superclasses

data.

Direct methods
Class: data-vector
Package

data-frame.

Source

data-frame.lisp.

Direct superclasses

data.

Direct methods

5.1.9 Types

Type: data-type ()

A statistical type for a data variable. All data columns must be one of these types if they are to be intepreted properly by Lisp-Stat

Package

data-frame.

Source

data-frame.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *data-frames*

Global list of all data frames

Package

data-frame.

Source

defdf.lisp.

Special Variable: *max-digits*
Package

data-frame.

Source

pprint.lisp.

Special Variable: *row-numbers-p*
Package

data-frame.

Source

pprint.lisp.


5.2.2 Macros

Macro: define-data-subclass (class abbreviation)
Package

data-frame.

Source

data-frame.lisp.

Macro: ensure-plist (pl)
Package

data-frame.

Source

plist-aops.lisp.


5.2.3 Ordinary functions

Function: 2d-array-to-list (array)

Convert an array to a list of lists

Package

data-frame.

Source

pprint.lisp.

Function: add-key! (ordered-keys key)

Modify ORDERED-KEYS by adding KEY.

Package

data-frame.

Source

data-frame.lisp.

Function: add-keys (ordered-keys &rest keys)

Add KEYS to ORDERED-KEYS

Package

data-frame.

Source

data-frame.lisp.

Function: aesthetic-string (thing)

Return the string used to represent ‘thing‘ when printing aesthetically.

Package

data-frame.

Source

formatted-output.lisp.

Function: alist-data (class alist)

Create an object of CLASS (subclass of DATA) from ALIST which contains key-column pairs.

Package

data-frame.

Source

data-frame.lisp.

Reader: bit-variable-summary-count (instance)
Package

data-frame.

Source

summary.lisp.

Target Slot

count.

Function: bit-variable-summary-desc (instance)
Package

data-frame.

Source

summary.lisp.

Function: bit-variable-summary-length (instance)
Package

data-frame.

Source

summary.lisp.

Function: bit-variable-summary-missing (instance)
Package

data-frame.

Source

summary.lisp.

Function: bit-variable-summary-name (instance)
Package

data-frame.

Source

summary.lisp.

Function: bit-variable-summary-p (object)
Package

data-frame.

Source

summary.lisp.

Function: column-type-format (sequence)

Return a format string for the most specific type found in sequence Use this for sequences of type T to determine how to format the column.

Package

data-frame.

Source

pprint.lisp.

Function: copy-bit-variable-summary (instance)
Package

data-frame.

Source

summary.lisp.

Function: copy-factor-variable-summary (instance)
Package

data-frame.

Source

summary.lisp.

Function: copy-generic-variable-summary (instance)
Package

data-frame.

Source

summary.lisp.

Function: copy-ordered-keys (ordered-keys)

Return a copy of ORDERED-KEYS

Package

data-frame.

Source

data-frame.lisp.

Function: copy-real-variable-summary (instance)
Package

data-frame.

Source

summary.lisp.

Function: copy-variable-summary% (instance)
Package

data-frame.

Source

summary.lisp.

Function: df-env-p (df)

Returns T if there is environment set-up for the data frame, or NIL if there isn’t one.

Package

data-frame.

Source

data-frame.lisp.

Function: df-exists-p (s)
Package

data-frame.

Source

conditions.lisp.

Function: distinct (column)

Returns the number of distinct elements in COLUMN, a symbol naming a variable. Useful for formatting columns for human output.

Package

data-frame.

Source

summary.lisp.

Function: drop-na (df)

Remove all rows from DF that are missing values. Convenience R-like function.

Package

data-frame.

Source

missing.lisp.

Function: ensure-arguments-alist (rest)

Recognizes the following and converts them to an alist:

plist
alist
(plist)
(alist)
(data-frame)

Package

data-frame.

Source

data-frame.lisp.

Function: ensure-not-ratio (real)

When REAL is a RATIO, convert it to a float, otherwise return as is. Used for printing.

Package

data-frame.

Source

summary.lisp.

Function: factor-variable-summary-desc (instance)
Package

data-frame.

Source

summary.lisp.

Reader: factor-variable-summary-element-count-alist (instance)
Package

data-frame.

Source

summary.lisp.

Target Slot

element-count-alist.

Function: factor-variable-summary-length (instance)
Package

data-frame.

Source

summary.lisp.

Function: factor-variable-summary-missing (instance)
Package

data-frame.

Source

summary.lisp.

Function: factor-variable-summary-name (instance)
Package

data-frame.

Source

summary.lisp.

Function: factor-variable-summary-p (object)
Package

data-frame.

Source

summary.lisp.

Function: generic-variable-summary-desc (instance)
Package

data-frame.

Source

summary.lisp.

Reader: generic-variable-summary-element-count-alist (instance)
Package

data-frame.

Source

summary.lisp.

Target Slot

element-count-alist.

Function: generic-variable-summary-length (instance)
Package

data-frame.

Source

summary.lisp.

Function: generic-variable-summary-missing (instance)
Package

data-frame.

Source

summary.lisp.

Function: generic-variable-summary-name (instance)
Package

data-frame.

Source

summary.lisp.

Function: generic-variable-summary-p (object)
Package

data-frame.

Source

summary.lisp.

Reader: generic-variable-summary-quantiles (instance)
Package

data-frame.

Source

summary.lisp.

Target Slot

quantiles.

Function: get-type (x)

Return the most specific type symbol for x

Package

data-frame.

Source

utils.lisp.

Function: invalid-df-name (s)

A user prompt, using DUOLOGUE, to select a valid data frame name.

Package

data-frame.

Source

conditions.lisp.

Function: key-index (ordered-keys key)

Return the index for KEY.

Package

data-frame.

Source

data-frame.lisp.

Function: key-list (data form)

Return a list of keys used in REST, a form

Package

data-frame.

Source

filter.lisp.

Function: keys-count (ordered-keys)

Number of keys.

Package

data-frame.

Source

data-frame.lisp.

Function: keys-vector (ordered-keys)

Vector of all keys.

Package

data-frame.

Source

data-frame.lisp.

Function: make-bit-variable-summary (&key length missing name desc count)
Package

data-frame.

Source

summary.lisp.

Function: make-data (class keys columns)

Create a DATA object from KEYS and COLUMNS. FOR INTERNAL USE. Always creates a copy of COLUMNS in order to ensure that it is an adjustable array with a fill pointer. KEYS are converted to ORDERED-KEYS if necessary.

Package

data-frame.

Source

data-frame.lisp.

Function: make-factor-variable-summary (&key length missing name desc element-count-alist)
Package

data-frame.

Source

summary.lisp.

Function: make-generic-variable-summary (&key length missing name desc quantiles element-count-alist)
Package

data-frame.

Source

summary.lisp.

Function: make-ordered-keys (&key table)
Package

data-frame.

Source

data-frame.lisp.

Function: make-real-variable-summary (&key length missing name desc min q25 q50 mean q75 max)
Package

data-frame.

Source

summary.lisp.

Function: make-variable-summary% (&key length missing name desc)
Package

data-frame.

Source

summary.lisp.

Function: max-decimal (sequence &optional max-digits)

Return the maximum number of digits to the right of the decimal point in the numbers of SEQUENCE, equal to or less than MAX-DIGITS

Package

data-frame.

Source

pprint.lisp.

Function: max-width (sequence &optional max-width)

Return the largest printed string size of the elements of SEQUENCE, equal to or less than MAX-WIDTH

Package

data-frame.

Source

pprint.lisp.

Function: monotonicp (column)

Returns T if all elements of COLUMN, a SYMBOL, are increasing monotonically Useful for detecting row numbers in imported data.

Package

data-frame.

Source

summary.lisp.

Function: ordered-keys (keys)

Create an ORDERED-KEYS object from KEYS (a sequence).

Package

data-frame.

Source

data-frame.lisp.

Function: ordered-keys-p (object)
Package

data-frame.

Source

data-frame.lisp.

Reader: ordered-keys-table (instance)
Package

data-frame.

Source

data-frame.lisp.

Target Slot

table.

Function: plist-data (class plist)

Create an object of CLASS (subclass of DATA) from PLIST which contains keys and columns, interleaved.

Package

data-frame.

Source

data-frame.lisp.

Function: print-count-and-percentage (stream count length)

Print COUNT as is and also as a rounded percentage

Package

data-frame.

Source

summary.lisp.

Function: print-table (rows &optional stream)

Print ROWS as a nicely-formatted table.
Each row should have the same number of colums.
Columns will be justified properly to fit the longest item in each one. Example:
(print-table ’((1 :red something)
(2 :green more)))
=>
1 | RED | SOMETHING
2 | GREEN | MORE

Package

data-frame.

Source

formatted-output.lisp.

Function: printer-status ()

Print values of all the printer variables

Package

data-frame.

Source

pprint.lisp.

Function: real-variable-summary-desc (instance)
Package

data-frame.

Source

summary.lisp.

Function: real-variable-summary-length (instance)
Package

data-frame.

Source

summary.lisp.

Reader: real-variable-summary-max (instance)
Package

data-frame.

Source

summary.lisp.

Target Slot

max.

Reader: real-variable-summary-mean (instance)
Package

data-frame.

Source

summary.lisp.

Target Slot

mean.

Reader: real-variable-summary-min (instance)
Package

data-frame.

Source

summary.lisp.

Target Slot

min.

Function: real-variable-summary-missing (instance)
Package

data-frame.

Source

summary.lisp.

Function: real-variable-summary-name (instance)
Package

data-frame.

Source

summary.lisp.

Function: real-variable-summary-p (object)
Package

data-frame.

Source

summary.lisp.

Reader: real-variable-summary-q25 (instance)
Package

data-frame.

Source

summary.lisp.

Target Slot

q25.

Reader: real-variable-summary-q50 (instance)
Package

data-frame.

Source

summary.lisp.

Target Slot

q50.

Reader: real-variable-summary-q75 (instance)
Package

data-frame.

Source

summary.lisp.

Target Slot

q75.

Function: remove-columns! (data &rest keys)

Modify DATA (a data-frame or data-vector) by removing columns with keys. If a data-frame environment exists, add columns to it as well.

Package

data-frame.

Source

data-frame.lisp.

Function: remove-key! (ordered-keys key)

Modify ORDERED-KEYS by removing KEY.

Package

data-frame.

Source

data-frame.lisp.

Function: reverse-df (df)

Return DF with columns in reverse order

Package

data-frame.

Source

pprint.lisp.

Function: show-properties (df)

Show the standard properties of the variables of the data frame DF Standard properties are ’label’, ’type’ and ’unit’

Package

data-frame.

Source

properties.lisp.

Function: show-symbols (pkg)

Print all symbols in PKG Example: (show-symbols ’mtcars)

Package

data-frame.

Source

defdf.lisp.

Function: summarize-factor-variable (column)

Return an alist of factor/count pairs

Package

data-frame.

Source

summary.lisp.

Function: summarize-generic-variable (column &optional name)

Return an object that summarizes COLUMN of a DATA-FRAME. Primarily intended for printing, not analysis, returned values should print nicely. This function can be used on any type of column, even one with mixed types

Package

data-frame.

Source

summary.lisp.

Function: summarize-real-variable (column)

Return a summary for a float variable

Package

data-frame.

Source

summary.lisp.

Function: types-in-column (seq)

Return a list of the types found in SEQ

Package

data-frame.

Source

utils.lisp.

Reader: variable-summary%-desc (instance)
Package

data-frame.

Source

summary.lisp.

Target Slot

desc.

Reader: variable-summary%-length (instance)
Package

data-frame.

Source

summary.lisp.

Target Slot

length.

Reader: variable-summary%-missing (instance)
Package

data-frame.

Source

summary.lisp.

Target Slot

missing.

Reader: variable-summary%-name (instance)
Package

data-frame.

Source

summary.lisp.

Target Slot

name.

Function: variable-summary%-p (object)
Package

data-frame.

Source

summary.lisp.

Function: weave (&rest lists)

Return a list whose elements alternate between each of the lists ‘lists‘. Weaving stops when any of the lists has been exhausted.

Package

data-frame.

Source

formatted-output.lisp.


5.2.4 Generic functions

Generic Function: check-column-compatibility (data column)

Check if COLUMN is compatible with DATA.

Package

data-frame.

Source

data-frame.lisp.

Methods
Method: check-column-compatibility ((data data-frame) column)
Method: check-column-compatibility ((data data) column)
Generic Function: column-length (column)

Return the length of column.

Package

data-frame.

Source

summary.lisp.

Methods
Method: column-length ((column vector))
Generic Reader: data-size (condition)
Package

data-frame.

Methods
Reader Method: data-size ((condition large-data))
Source

conditions.lisp.

Target Slot

data-size.

Generic Function: default-column-formats (array)
Package

data-frame.

Methods
Method: default-column-formats ((array simple-array))

Return a list of formatting strings for ARRAY
The method returns a set of default formatting strings using heuristics.

Source

pprint.lisp.


5.2.5 Conditions

Condition: data-frame-exists

An attempt to redefine an existing data frame. Triggered if either the symbol is bound or the package exists.

Package

data-frame.

Source

conditions.lisp.

Direct superclasses

error.

Direct methods

data-frame.

Direct slots
Slot: data-frame
Initargs

:data-frame

Readers

data-frame.

Writers

This slot is read-only.

Condition: missing-data

A variable has missing data, e.g. :na, nil

Package

data-frame.

Source

conditions.lisp.

Direct superclasses

error.

Direct slots
Slot: name
Initargs

:name

Slot: data
Initargs

:data


5.2.6 Structures

Structure: ordered-keys

Representation of ordered keys
Ordered keys provide a mapping from column keys (symbols) to nonnegative integers. They are used internally and the corresponding interface is NOT EXPORTED.

TABLE maps keys to indexes, starting from zero.

Package

data-frame.

Source

data-frame.lisp.

Direct superclasses

structure-object.

Direct methods
Direct slots
Slot: table
Type

hash-table

Initform

(make-hash-table :test (function eq))

Readers

ordered-keys-table.

Writers

This slot is read-only.

Structure: variable-summary%

Base class for summarizing variables. Summary functions take SYMBOLs, rather than values, because the symbol property lists naming the variables have meta-data, e.g. type, label, that we want to print. Not exported.

Package

data-frame.

Source

summary.lisp.

Direct superclasses

structure-object.

Direct subclasses
Direct slots
Slot: length
Package

common-lisp.

Type

alexandria:array-index

Initform

0

Readers

variable-summary%-length.

Writers

This slot is read-only.

Slot: missing
Type

fixnum

Initform

0

Readers

variable-summary%-missing.

Writers

This slot is read-only.

Slot: name
Type

string

Initform

""

Readers

variable-summary%-name.

Writers

This slot is read-only.

Slot: desc
Type

string

Initform

""

Readers

variable-summary%-desc.

Writers

This slot is read-only.


5.2.7 Classes

Class: data

This class is used for implementing both data-vector and data-frame, and represents an ordered collection of key-column pairs. Columns are not assumed to have any specific attributes. This class is not exported.

Package

data-frame.

Source

data-frame.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: name

The name of the data frame. MUST be the same as the symbol whose value cell points to this data frame. This slot essentially allows us to go ’backwards’ and get the symbol that names the data frame.

Type

string

Initargs

nil

Readers

name.

Writers

(setf name).

Slot: ordered-keys
Type

data-frame::ordered-keys

Initargs

:ordered-keys

Slot: columns
Type

vector

Initargs

:columns


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (   2  
A   B   C   D   E   F   G   H   I   K   M   N   O   P   R   S   T   U   V   W  
Index Entry  Section

(
(setf column): Public ordinary functions
(setf name): Public generic functions
(setf name): Public generic functions

2
2d-array-to-list: Private ordinary functions

A
add-column!: Public ordinary functions
add-columns: Public ordinary functions
add-columns!: Public ordinary functions
add-key!: Private ordinary functions
add-keys: Private ordinary functions
aesthetic-string: Private ordinary functions
alist-data: Private ordinary functions
alist-df: Public ordinary functions
alist-dv: Public ordinary functions
as-alist: Public standalone methods
as-array: Public standalone methods
as-array: Public standalone methods
axis-dimension: Public standalone methods

B
bit-variable-summary-count: Private ordinary functions
bit-variable-summary-desc: Private ordinary functions
bit-variable-summary-length: Private ordinary functions
bit-variable-summary-missing: Private ordinary functions
bit-variable-summary-name: Private ordinary functions
bit-variable-summary-p: Private ordinary functions

C
canonical-representation: Public standalone methods
check-column-compatibility: Private generic functions
check-column-compatibility: Private generic functions
check-column-compatibility: Private generic functions
column: Public ordinary functions
column-length: Private generic functions
column-length: Private generic functions
column-names: Public ordinary functions
column-type: Public ordinary functions
column-type-format: Private ordinary functions
columns: Public ordinary functions
copy: Public ordinary functions
copy-bit-variable-summary: Private ordinary functions
copy-factor-variable-summary: Private ordinary functions
copy-generic-variable-summary: Private ordinary functions
copy-ordered-keys: Private ordinary functions
copy-real-variable-summary: Private ordinary functions
copy-variable-summary%: Private ordinary functions
count-rows: Public ordinary functions

D
data-frame: Public generic functions
data-frame: Public generic functions
data-size: Private generic functions
data-size: Private generic functions
default-column-formats: Private generic functions
default-column-formats: Private generic functions
defdf: Public macros
defdf-env: Public ordinary functions
define-data-subclass: Private macros
delete-nth: Public ordinary functions
delete-nth*: Public macros
describe-object: Public standalone methods
df: Public ordinary functions
df-env-p: Private ordinary functions
df-exists-p: Private ordinary functions
df-print: Public ordinary functions
df-remove-duplicates: Public ordinary functions
dims: Public standalone methods
dims: Public standalone methods
distinct: Private ordinary functions
do-rows: Public ordinary functions
drop-missing: Public generic functions
drop-missing: Public generic functions
drop-missing: Public generic functions
drop-na: Private ordinary functions
dv: Public ordinary functions

E
element-type: Public standalone methods
ensure-arguments-alist: Private ordinary functions
ensure-not-ratio: Private ordinary functions
ensure-plist: Private macros

F
factor-variable-summary-desc: Private ordinary functions
factor-variable-summary-element-count-alist: Private ordinary functions
factor-variable-summary-length: Private ordinary functions
factor-variable-summary-missing: Private ordinary functions
factor-variable-summary-name: Private ordinary functions
factor-variable-summary-p: Private ordinary functions
filter-rows: Public ordinary functions
Function, (setf column): Public ordinary functions
Function, 2d-array-to-list: Private ordinary functions
Function, add-column!: Public ordinary functions
Function, add-columns: Public ordinary functions
Function, add-columns!: Public ordinary functions
Function, add-key!: Private ordinary functions
Function, add-keys: Private ordinary functions
Function, aesthetic-string: Private ordinary functions
Function, alist-data: Private ordinary functions
Function, alist-df: Public ordinary functions
Function, alist-dv: Public ordinary functions
Function, bit-variable-summary-count: Private ordinary functions
Function, bit-variable-summary-desc: Private ordinary functions
Function, bit-variable-summary-length: Private ordinary functions
Function, bit-variable-summary-missing: Private ordinary functions
Function, bit-variable-summary-name: Private ordinary functions
Function, bit-variable-summary-p: Private ordinary functions
Function, column: Public ordinary functions
Function, column-names: Public ordinary functions
Function, column-type: Public ordinary functions
Function, column-type-format: Private ordinary functions
Function, columns: Public ordinary functions
Function, copy: Public ordinary functions
Function, copy-bit-variable-summary: Private ordinary functions
Function, copy-factor-variable-summary: Private ordinary functions
Function, copy-generic-variable-summary: Private ordinary functions
Function, copy-ordered-keys: Private ordinary functions
Function, copy-real-variable-summary: Private ordinary functions
Function, copy-variable-summary%: Private ordinary functions
Function, count-rows: Public ordinary functions
Function, defdf-env: Public ordinary functions
Function, delete-nth: Public ordinary functions
Function, df: Public ordinary functions
Function, df-env-p: Private ordinary functions
Function, df-exists-p: Private ordinary functions
Function, df-print: Public ordinary functions
Function, df-remove-duplicates: Public ordinary functions
Function, distinct: Private ordinary functions
Function, do-rows: Public ordinary functions
Function, drop-na: Private ordinary functions
Function, dv: Public ordinary functions
Function, ensure-arguments-alist: Private ordinary functions
Function, ensure-not-ratio: Private ordinary functions
Function, factor-variable-summary-desc: Private ordinary functions
Function, factor-variable-summary-element-count-alist: Private ordinary functions
Function, factor-variable-summary-length: Private ordinary functions
Function, factor-variable-summary-missing: Private ordinary functions
Function, factor-variable-summary-name: Private ordinary functions
Function, factor-variable-summary-p: Private ordinary functions
Function, filter-rows: Public ordinary functions
Function, generic-variable-summary-desc: Private ordinary functions
Function, generic-variable-summary-element-count-alist: Private ordinary functions
Function, generic-variable-summary-length: Private ordinary functions
Function, generic-variable-summary-missing: Private ordinary functions
Function, generic-variable-summary-name: Private ordinary functions
Function, generic-variable-summary-p: Private ordinary functions
Function, generic-variable-summary-quantiles: Private ordinary functions
Function, get-property: Public ordinary functions
Function, get-summaries: Public ordinary functions
Function, get-type: Private ordinary functions
Function, heuristicate-types: Public ordinary functions
Function, ignore-missing: Public ordinary functions
Function, invalid-df-name: Private ordinary functions
Function, key-index: Private ordinary functions
Function, key-list: Private ordinary functions
Function, keys: Public ordinary functions
Function, keys-count: Private ordinary functions
Function, keys-vector: Private ordinary functions
Function, make-bit-variable-summary: Private ordinary functions
Function, make-data: Private ordinary functions
Function, make-df: Public ordinary functions
Function, make-dv: Public ordinary functions
Function, make-factor-variable-summary: Private ordinary functions
Function, make-generic-variable-summary: Private ordinary functions
Function, make-ordered-keys: Private ordinary functions
Function, make-real-variable-summary: Private ordinary functions
Function, make-variable-summary%: Private ordinary functions
Function, map-columns: Public ordinary functions
Function, map-df: Public ordinary functions
Function, map-rows: Public ordinary functions
Function, mask-rows: Public ordinary functions
Function, matrix-df: Public ordinary functions
Function, max-decimal: Private ordinary functions
Function, max-width: Private ordinary functions
Function, monotonicp: Private ordinary functions
Function, ordered-keys: Private ordinary functions
Function, ordered-keys-p: Private ordinary functions
Function, ordered-keys-table: Private ordinary functions
Function, plist-data: Private ordinary functions
Function, plist-df: Public ordinary functions
Function, plist-dv: Public ordinary functions
Function, print-array: Public ordinary functions
Function, print-count-and-percentage: Private ordinary functions
Function, print-data: Public ordinary functions
Function, print-markdown: Public ordinary functions
Function, print-table: Private ordinary functions
Function, printer-status: Private ordinary functions
Function, real-variable-summary-desc: Private ordinary functions
Function, real-variable-summary-length: Private ordinary functions
Function, real-variable-summary-max: Private ordinary functions
Function, real-variable-summary-mean: Private ordinary functions
Function, real-variable-summary-min: Private ordinary functions
Function, real-variable-summary-missing: Private ordinary functions
Function, real-variable-summary-name: Private ordinary functions
Function, real-variable-summary-p: Private ordinary functions
Function, real-variable-summary-q25: Private ordinary functions
Function, real-variable-summary-q50: Private ordinary functions
Function, real-variable-summary-q75: Private ordinary functions
Function, remove-column!: Public ordinary functions
Function, remove-columns: Public ordinary functions
Function, remove-columns!: Private ordinary functions
Function, remove-key!: Private ordinary functions
Function, replace-column: Public ordinary functions
Function, replace-column!: Public ordinary functions
Function, reverse-df: Private ordinary functions
Function, rows: Public ordinary functions
Function, set-properties: Public ordinary functions
Function, set-property: Public ordinary functions
Function, short-string: Public ordinary functions
Function, show-data-frames: Public ordinary functions
Function, show-properties: Private ordinary functions
Function, show-symbols: Private ordinary functions
Function, summarize-column: Public ordinary functions
Function, summarize-factor-variable: Private ordinary functions
Function, summarize-generic-variable: Private ordinary functions
Function, summarize-real-variable: Private ordinary functions
Function, summary: Public ordinary functions
Function, types-in-column: Private ordinary functions
Function, undef: Public ordinary functions
Function, variable-summary%-desc: Private ordinary functions
Function, variable-summary%-length: Private ordinary functions
Function, variable-summary%-missing: Private ordinary functions
Function, variable-summary%-name: Private ordinary functions
Function, variable-summary%-p: Private ordinary functions
Function, weave: Private ordinary functions

G
Generic Function, (setf name): Public generic functions
Generic Function, check-column-compatibility: Private generic functions
Generic Function, column-length: Private generic functions
Generic Function, data-frame: Public generic functions
Generic Function, data-size: Private generic functions
Generic Function, default-column-formats: Private generic functions
Generic Function, drop-missing: Public generic functions
Generic Function, head: Public generic functions
Generic Function, missingp: Public generic functions
Generic Function, name: Public generic functions
Generic Function, rename-column!: Public generic functions
Generic Function, replace-missing: Public generic functions
Generic Function, tail: Public generic functions
generic-variable-summary-desc: Private ordinary functions
generic-variable-summary-element-count-alist: Private ordinary functions
generic-variable-summary-length: Private ordinary functions
generic-variable-summary-missing: Private ordinary functions
generic-variable-summary-name: Private ordinary functions
generic-variable-summary-p: Private ordinary functions
generic-variable-summary-quantiles: Private ordinary functions
get-property: Public ordinary functions
get-summaries: Public ordinary functions
get-type: Private ordinary functions

H
head: Public generic functions
head: Public generic functions
heuristicate-types: Public ordinary functions

I
ignore-missing: Public ordinary functions
initialize-instance: Public standalone methods
invalid-df-name: Private ordinary functions

K
key-index: Private ordinary functions
key-list: Private ordinary functions
keys: Public ordinary functions
keys-count: Private ordinary functions
keys-vector: Private ordinary functions

M
Macro, defdf: Public macros
Macro, define-data-subclass: Private macros
Macro, delete-nth*: Public macros
Macro, ensure-plist: Private macros
make-bit-variable-summary: Private ordinary functions
make-data: Private ordinary functions
make-df: Public ordinary functions
make-dv: Public ordinary functions
make-factor-variable-summary: Private ordinary functions
make-generic-variable-summary: Private ordinary functions
make-ordered-keys: Private ordinary functions
make-real-variable-summary: Private ordinary functions
make-variable-summary%: Private ordinary functions
map-columns: Public ordinary functions
map-df: Public ordinary functions
map-rows: Public ordinary functions
mask-rows: Public ordinary functions
matrix-df: Public ordinary functions
max-decimal: Private ordinary functions
max-width: Private ordinary functions
Method, (setf name): Public generic functions
Method, as-alist: Public standalone methods
Method, as-array: Public standalone methods
Method, as-array: Public standalone methods
Method, axis-dimension: Public standalone methods
Method, canonical-representation: Public standalone methods
Method, check-column-compatibility: Private generic functions
Method, check-column-compatibility: Private generic functions
Method, column-length: Private generic functions
Method, data-frame: Public generic functions
Method, data-size: Private generic functions
Method, default-column-formats: Private generic functions
Method, describe-object: Public standalone methods
Method, dims: Public standalone methods
Method, dims: Public standalone methods
Method, drop-missing: Public generic functions
Method, drop-missing: Public generic functions
Method, element-type: Public standalone methods
Method, head: Public generic functions
Method, initialize-instance: Public standalone methods
Method, missingp: Public generic functions
Method, missingp: Public generic functions
Method, missingp: Public generic functions
Method, missingp: Public generic functions
Method, missingp: Public generic functions
Method, missingp: Public generic functions
Method, missingp: Public generic functions
Method, name: Public generic functions
Method, ncol: Public standalone methods
Method, nrow: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, random-sample: Public standalone methods
Method, rename-column!: Public generic functions
Method, replace-missing: Public generic functions
Method, select: Public standalone methods
Method, select: Public standalone methods
Method, select: Public standalone methods
Method, tail: Public generic functions
missingp: Public generic functions
missingp: Public generic functions
missingp: Public generic functions
missingp: Public generic functions
missingp: Public generic functions
missingp: Public generic functions
missingp: Public generic functions
missingp: Public generic functions
monotonicp: Private ordinary functions

N
name: Public generic functions
name: Public generic functions
ncol: Public standalone methods
nrow: Public standalone methods

O
ordered-keys: Private ordinary functions
ordered-keys-p: Private ordinary functions
ordered-keys-table: Private ordinary functions

P
plist-data: Private ordinary functions
plist-df: Public ordinary functions
plist-dv: Public ordinary functions
print-array: Public ordinary functions
print-count-and-percentage: Private ordinary functions
print-data: Public ordinary functions
print-markdown: Public ordinary functions
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-table: Private ordinary functions
printer-status: Private ordinary functions

R
random-sample: Public standalone methods
real-variable-summary-desc: Private ordinary functions
real-variable-summary-length: Private ordinary functions
real-variable-summary-max: Private ordinary functions
real-variable-summary-mean: Private ordinary functions
real-variable-summary-min: Private ordinary functions
real-variable-summary-missing: Private ordinary functions
real-variable-summary-name: Private ordinary functions
real-variable-summary-p: Private ordinary functions
real-variable-summary-q25: Private ordinary functions
real-variable-summary-q50: Private ordinary functions
real-variable-summary-q75: Private ordinary functions
remove-column!: Public ordinary functions
remove-columns: Public ordinary functions
remove-columns!: Private ordinary functions
remove-key!: Private ordinary functions
rename-column!: Public generic functions
rename-column!: Public generic functions
replace-column: Public ordinary functions
replace-column!: Public ordinary functions
replace-missing: Public generic functions
replace-missing: Public generic functions
reverse-df: Private ordinary functions
rows: Public ordinary functions

S
select: Public standalone methods
select: Public standalone methods
select: Public standalone methods
set-properties: Public ordinary functions
set-property: Public ordinary functions
short-string: Public ordinary functions
show-data-frames: Public ordinary functions
show-properties: Private ordinary functions
show-symbols: Private ordinary functions
summarize-column: Public ordinary functions
summarize-factor-variable: Private ordinary functions
summarize-generic-variable: Private ordinary functions
summarize-real-variable: Private ordinary functions
summary: Public ordinary functions

T
tail: Public generic functions
tail: Public generic functions
types-in-column: Private ordinary functions

U
undef: Public ordinary functions

V
variable-summary%-desc: Private ordinary functions
variable-summary%-length: Private ordinary functions
variable-summary%-missing: Private ordinary functions
variable-summary%-name: Private ordinary functions
variable-summary%-p: Private ordinary functions

W
weave: Private ordinary functions


A.3 Variables

Jump to:   *  
C   D   E   K   L   M   N   O   Q   S   T  
Index Entry  Section

*
*ask-on-redefine*: Public special variables
*data-frames*: Private special variables
*distinct-maximum*: Public special variables
*distinct-threshold*: Public special variables
*large-data*: Public special variables
*max-digits*: Private special variables
*quantile-threshold*: Public special variables
*row-numbers-p*: Private special variables
*summary-minimum-length*: Public special variables

C
columns: Private classes
count: Public structures

D
data: Private conditions
data-frame: Private conditions
data-size: Public conditions
desc: Private structures

E
element-count-alist: Public structures
element-count-alist: Public structures

K
key: Public conditions
key: Public conditions
keys: Public conditions

L
length: Private structures

M
max: Public structures
mean: Public structures
min: Public structures
missing: Private structures

N
name: Private conditions
name: Private structures
name: Private classes

O
ordered-keys: Private classes

Q
q25: Public structures
q50: Public structures
q75: Public structures
quantiles: Public structures

S
Slot, columns: Private classes
Slot, count: Public structures
Slot, data: Private conditions
Slot, data-frame: Private conditions
Slot, data-size: Public conditions
Slot, desc: Private structures
Slot, element-count-alist: Public structures
Slot, element-count-alist: Public structures
Slot, key: Public conditions
Slot, key: Public conditions
Slot, keys: Public conditions
Slot, length: Private structures
Slot, max: Public structures
Slot, mean: Public structures
Slot, min: Public structures
Slot, missing: Private structures
Slot, name: Private conditions
Slot, name: Private structures
Slot, name: Private classes
Slot, ordered-keys: Private classes
Slot, q25: Public structures
Slot, q50: Public structures
Slot, q75: Public structures
Slot, quantiles: Public structures
Slot, table: Private structures
Special Variable, *ask-on-redefine*: Public special variables
Special Variable, *data-frames*: Private special variables
Special Variable, *distinct-maximum*: Public special variables
Special Variable, *distinct-threshold*: Public special variables
Special Variable, *large-data*: Public special variables
Special Variable, *max-digits*: Private special variables
Special Variable, *quantile-threshold*: Public special variables
Special Variable, *row-numbers-p*: Private special variables
Special Variable, *summary-minimum-length*: Public special variables

T
table: Private structures


A.4 Data types

Jump to:   B   C   D   F   G   K   L   M   O   P   R   S   T   U   V  
Index Entry  Section

B
bit-variable-summary: Public structures

C
Class, data: Private classes
Class, data-frame: Public classes
Class, data-vector: Public classes
Condition, data-frame-exists: Private conditions
Condition, duplicate-key: Public conditions
Condition, key-not-found: Public conditions
Condition, large-data: Public conditions
Condition, missing-data: Private conditions
conditions.lisp: The data-frame/conditions․lisp file

D
data: Private classes
data-frame: The data-frame system
data-frame: The data-frame package
data-frame: Public classes
data-frame-exists: Private conditions
data-frame.asd: The data-frame/data-frame․asd file
data-frame.lisp: The data-frame/data-frame․lisp file
data-type: Public types
data-vector: Public classes
defdf.lisp: The data-frame/defdf․lisp file
duplicate-key: Public conditions

F
factor-variable-summary: Public structures
File, conditions.lisp: The data-frame/conditions․lisp file
File, data-frame.asd: The data-frame/data-frame․asd file
File, data-frame.lisp: The data-frame/data-frame․lisp file
File, defdf.lisp: The data-frame/defdf․lisp file
File, filter.lisp: The data-frame/filter․lisp file
File, formatted-output.lisp: The data-frame/formatted-output․lisp file
File, missing.lisp: The data-frame/missing․lisp file
File, pkgdcl.lisp: The data-frame/pkgdcl․lisp file
File, plist-aops.lisp: The data-frame/plist-aops․lisp file
File, pprint.lisp: The data-frame/pprint․lisp file
File, properties.lisp: The data-frame/properties․lisp file
File, summary.lisp: The data-frame/summary․lisp file
File, utils.lisp: The data-frame/utils․lisp file
filter.lisp: The data-frame/filter․lisp file
formatted-output.lisp: The data-frame/formatted-output․lisp file

G
generic-variable-summary: Public structures

K
key-not-found: Public conditions

L
large-data: Public conditions

M
missing-data: Private conditions
missing.lisp: The data-frame/missing․lisp file

O
ordered-keys: Private structures

P
Package, data-frame: The data-frame package
pkgdcl.lisp: The data-frame/pkgdcl․lisp file
plist-aops.lisp: The data-frame/plist-aops․lisp file
pprint.lisp: The data-frame/pprint․lisp file
properties.lisp: The data-frame/properties․lisp file

R
real-variable-summary: Public structures

S
Structure, bit-variable-summary: Public structures
Structure, factor-variable-summary: Public structures
Structure, generic-variable-summary: Public structures
Structure, ordered-keys: Private structures
Structure, real-variable-summary: Public structures
Structure, variable-summary%: Private structures
summary.lisp: The data-frame/summary․lisp file
System, data-frame: The data-frame system

T
Type, data-type: Public types

U
utils.lisp: The data-frame/utils․lisp file

V
variable-summary%: Private structures