The data-frame Reference Manual

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

• column-type (function).
• delete-nth (function).
• delete-nth* (macro).

Internals

• get-type (function).
• types-in-column (function).

---

3.1.4 data-frame/data-frame.lisp

Dependency

utils.lisp (file).

Source

data-frame.asd.

Parent Component

data-frame (system).

Public Interface

• *large-data* (special variable).
• add-column! (function).
• add-columns (function).
• add-columns! (function).
• alist-df (function).
• alist-dv (function).
• as-alist (method).
• as-array (method).
• as-array (method).
• axis-dimension (method).
• canonical-representation (method).
• column (function).
• (setf column) (function).
• column-names (function).
• columns (function).
• copy (function).
• count-rows (function).
• data-frame (class).
• data-type (type).
• data-vector (class).
• describe-object (method).
• df (function).
• df-remove-duplicates (function).
• dims (method).
• dims (method).
• do-rows (function).
• dv (function).
• element-type (method).
• initialize-instance (method).
• keys (function).
• make-df (function).
• make-dv (function).
• map-columns (function).
• map-df (function).
• map-rows (function).
• mask-rows (function).
• matrix-df (function).
• name (reader method).
• (setf name) (writer method).
• ncol (method).
• nrow (method).
• plist-df (function).
• plist-dv (function).
• print-object (method).
• print-object (method).
• print-object (method).
• remove-column! (function).
• remove-columns (function).
• rename-column! (method).
• replace-column (function).
• replace-column! (function).
• rows (function).
• sample (method).
• select (method).
• select (method).
• select (method).

Internals

• add-key! (function).
• add-keys (function).
• alist-data (function).
• check-column-compatibility (generic function).
• copy-ordered-keys (function).
• data (class).
• define-data-subclass (macro).
• df-env-p (function).
• ensure-arguments-alist (function).
• key-index (function).
• keys-count (function).
• keys-vector (function).
• make-data (function).
• make-ordered-keys (function).
• ordered-keys (function).
• ordered-keys (structure).
• ordered-keys-p (function).
• ordered-keys-table (reader).
• plist-data (function).
• remove-columns! (function).
• remove-key! (function).

---

3.1.5 data-frame/pprint.lisp

Dependency

data-frame.lisp (file).

Source

data-frame.asd.

Parent Component

data-frame (system).

Public Interface

• head (method).
• print-array (function).
• print-data (function).
• short-string (function).
• tail (method).

Internals

• *max-digits* (special variable).
• *row-numbers-p* (special variable).
• 2d-array-to-list (function).
• column-type-format (function).
• default-column-formats (function).
• max-decimal (function).
• max-width (function).
• printer-status (function).
• reverse-df (function).

---

3.1.6 data-frame/formatted-output.lisp

Dependency

pprint.lisp (file).

Source

data-frame.asd.

Parent Component

data-frame (system).

Public Interface

• df-print (function).
• print-markdown (function).

Internals

• aesthetic-string (function).
• print-table (function).
• weave (function).

---

3.1.7 data-frame/summary.lisp

Dependency

formatted-output.lisp (file).

Source

data-frame.asd.

Parent Component

data-frame (system).

Public Interface

• *distinct-maximum* (special variable).
• *distinct-threshold* (special variable).
• *quantile-threshold* (special variable).
• *summary-minimum-length* (special variable).
• bit-variable-summary (structure).
• factor-variable-summary (structure).
• generic-variable-summary (structure).
• get-summaries (function).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• real-variable-summary (structure).
• summarize-column (function).
• summary (function).

Internals

• bit-variable-summary-count (reader).
• bit-variable-summary-desc (function).
• bit-variable-summary-length (function).
• bit-variable-summary-missing (function).
• bit-variable-summary-name (function).
• bit-variable-summary-p (function).
• column-length (generic function).
• copy-bit-variable-summary (function).
• copy-factor-variable-summary (function).
• copy-generic-variable-summary (function).
• copy-real-variable-summary (function).
• copy-variable-summary% (function).
• distinct (function).
• ensure-not-ratio (function).
• factor-variable-summary-desc (function).
• factor-variable-summary-element-count-alist (reader).
• factor-variable-summary-length (function).
• factor-variable-summary-missing (function).
• factor-variable-summary-name (function).
• factor-variable-summary-p (function).
• generic-variable-summary-desc (function).
• generic-variable-summary-element-count-alist (reader).
• generic-variable-summary-length (function).
• generic-variable-summary-missing (function).
• generic-variable-summary-name (function).
• generic-variable-summary-p (function).
• generic-variable-summary-quantiles (reader).
• make-bit-variable-summary (function).
• make-factor-variable-summary (function).
• make-generic-variable-summary (function).
• make-real-variable-summary (function).
• make-variable-summary% (function).
• monotonicp (function).
• print-count-and-percentage (function).
• real-variable-summary-desc (function).
• real-variable-summary-length (function).
• real-variable-summary-max (reader).
• real-variable-summary-mean (reader).
• real-variable-summary-min (reader).
• real-variable-summary-missing (function).
• real-variable-summary-name (function).
• real-variable-summary-p (function).
• real-variable-summary-q25 (reader).
• real-variable-summary-q50 (reader).
• real-variable-summary-q75 (reader).
• summarize-factor-variable (function).
• summarize-generic-variable (function).
• summarize-real-variable (function).
• variable-summary% (structure).
• variable-summary%-desc (reader).
• variable-summary%-length (reader).
• variable-summary%-missing (reader).
• variable-summary%-name (reader).
• variable-summary%-p (function).

---

3.1.8 data-frame/defdf.lisp

Dependency

summary.lisp (file).

Source

data-frame.asd.

Parent Component

data-frame (system).

Public Interface

• *ask-on-redefine* (special variable).
• defdf (macro).
• defdf-env (function).
• show-data-frames (function).
• undef (function).

Internals

• *data-frames* (special variable).
• show-symbols (function).

---

3.1.9 data-frame/conditions.lisp

Dependency

defdf.lisp (file).

Source

data-frame.asd.

Parent Component

data-frame (system).

Public Interface

• data-frame (reader method).
• duplicate-key (condition).
• key-not-found (condition).
• large-data (condition).

Internals

• data-frame-exists (condition).
• data-size (reader method).
• df-exists-p (function).
• invalid-df-name (function).
• missing-data (condition).

---

3.1.10 data-frame/properties.lisp

Dependency

conditions.lisp (file).

Source

data-frame.asd.

Parent Component

data-frame (system).

Public Interface

• get-property (function).
• heuristicate-types (function).
• set-properties (function).
• set-property (function).

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

• drop-missing (method).
• drop-missing (method).
• ignore-missing (function).
• missingp (generic function).
• replace-missing (method).

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).

---

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: sample ((df data-frame) n &key with-replacement skip-unselected) ¶

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").

If SKIP-UNSELECTED is non-NIL, do not return the elements of DF that we not part of the selection. Non-NIL by default, as the typical use case is to split a data set into training and test data sets.

Package

select.

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

• as-array.
• check-column-compatibility.
• describe-object.
• dims.
• drop-missing.
• head.
• initialize-instance.
• missingp.
• ncol.
• nrow.
• print-object.
• replace-missing.
• sample.
• select.
• tail.

Class: data-vector ¶

Package

data-frame.

Source

data-frame.lisp.

Direct superclasses

data.

Direct methods

• as-array.
• dims.
• print-object.
• select.

---

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.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: default-column-formats (array) ¶

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

Package

data-frame.

Source

pprint.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.

---

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

• axis-dimension.
• canonical-representation.
• print-object.
• select.

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

• bit-variable-summary.
• factor-variable-summary.
• generic-variable-summary.
• real-variable-summary.

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.

---