The plot Reference Manual

Table of Contents

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

The plot Reference Manual

This is the plot Reference Manual, version 1.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Oct 13 12:10:00 2021 GMT+0.


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

1 Introduction

Contributors Forks Stargazers Issues MS-PL License LinkedIn

About the Project

The Plot system provides a way to visualise data. It includes functions for text-based plotting that work in the REPL, and JavaScript visualisations that are rendered in a browser. It is designed as a front end 'grammar', modeled after that Grammar of Graphics and implemented with various back ends. Currently only Vega-Lite is complete as a backend. It is integrated with data-frame, but can also be used independently.

Built With

Getting Started

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

Prerequisites

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

Installation

  1. Clone the repository
    cd ~/quicklisp/local-projects &&
    git clone https://github.com/Lisp-Stat/plot.git
    
  2. Reset the ASDF source-registry to find the new system (from the REPL)
    (asdf:clear-source-registry)
    
  3. Load the system
    (ql:quickload :plot)
    

Usage

For examples, please refer to the Documentation.

Roadmap

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

Resources

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

Contributing

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

License

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

Contact

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


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

2 Systems

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


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

2.1 plot

Author

Steve Nunez <steve@symbolics.tech>

License

MS-PL

Description

Plots for Common Lisp

Long Description

A plotting system for Common Lisp

Version

1.1

Dependencies
Source

plot.asd (file)

Components

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

3 Files

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


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

3.1 Lisp


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

3.1.1 plot.asd

Location

plot.asd

Systems

plot (system)


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

3.1.2 plot/pkgdcl.lisp

Parent

plot (system)

Location

pkgdcl.lisp

Packages

plot


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

3.1.3 plot/init.lisp

Dependency

pkgdcl.lisp (file)

Parent

plot (system)

Location

init.lisp


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

3.1.4 plot/browser.lisp

Dependency

init.lisp (file)

Parent

plot (system)

Location

browser.lisp

Exported Definitions
Internal Definitions

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

3.1.5 plot/plot.lisp

Dependency

browser.lisp (file)

Parent

plot (system)

Location

plot.lisp

Exported Definitions

plot-from-file (function)


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

4 Packages

Packages are listed by definition order.


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

4.1 plot

Source

pkgdcl.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Special variables

Special Variable: *browser-commands*
Package

plot

Source

browser.lisp (file)

Special Variable: *default-browser-command*
Package

plot

Source

browser.lisp (file)

Special Variable: *default-browser-options*
Package

plot

Source

browser.lisp (file)


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

5.1.2 Functions

Function: plot-from-file FILESPEC &key BROWSER BROWSER-OPTIONS

Open plot specification FILESPEC

Package

plot

Source

plot.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *default-chrome-options*
Package

plot

Source

browser.lisp (file)


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

5.2.2 Functions

Function: %print-alist STREAM DATA &rest ARGS
Package

plot

Source

browser.lisp (file)

Function: encode-application-options OPTIONS ARG-FORMAT

Turns OPTIONS, an alist, into a command line argument list according to ARG-FORMAT

Package

plot

Source

browser.lisp (file)

Function: encode-chrome-options OPTIONS

Encode command line options for Chrome

Package

plot

Source

browser.lisp (file)

Function: set-chrome-size SIZE

Set the windows size in *default-browser-options*

Package

plot

Source

browser.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   P  
Index Entry  Section

F
File, Lisp, plot.asd: The plot․asd file
File, Lisp, plot/browser.lisp: The plot/browser․lisp file
File, Lisp, plot/init.lisp: The plot/init․lisp file
File, Lisp, plot/pkgdcl.lisp: The plot/pkgdcl․lisp file
File, Lisp, plot/plot.lisp: The plot/plot․lisp file

L
Lisp File, plot.asd: The plot․asd file
Lisp File, plot/browser.lisp: The plot/browser․lisp file
Lisp File, plot/init.lisp: The plot/init․lisp file
Lisp File, plot/pkgdcl.lisp: The plot/pkgdcl․lisp file
Lisp File, plot/plot.lisp: The plot/plot․lisp file

P
plot.asd: The plot․asd file
plot/browser.lisp: The plot/browser․lisp file
plot/init.lisp: The plot/init․lisp file
plot/pkgdcl.lisp: The plot/pkgdcl․lisp file
plot/plot.lisp: The plot/plot․lisp file

Jump to:   F   L   P  

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

A.2 Functions

Jump to:   %  
E   F   P   S  
Index Entry  Section

%
%print-alist: Internal functions

E
encode-application-options: Internal functions
encode-chrome-options: Internal functions

F
Function, %print-alist: Internal functions
Function, encode-application-options: Internal functions
Function, encode-chrome-options: Internal functions
Function, plot-from-file: Exported functions
Function, set-chrome-size: Internal functions

P
plot-from-file: Exported functions

S
set-chrome-size: Internal functions

Jump to:   %  
E   F   P   S  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*browser-commands*: Exported special variables
*default-browser-command*: Exported special variables
*default-browser-options*: Exported special variables
*default-chrome-options*: Internal special variables

S
Special Variable, *browser-commands*: Exported special variables
Special Variable, *default-browser-command*: Exported special variables
Special Variable, *default-browser-options*: Exported special variables
Special Variable, *default-chrome-options*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   P   S  
Index Entry  Section

P
Package, plot: The plot package
plot: The plot system
plot: The plot package

S
System, plot: The plot system

Jump to:   P   S