The plot Reference Manual

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

The plot Reference Manual

This is the plot Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 05:33:54 2022 GMT+0.

Table of Contents


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 Vega-Lite is complete as a backend. It is integrated with data-frame, and 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

To make the system accessible to ASDF (a build facility, similar to make in the C world), clone the repository in a directory ASDF knows about. By default the common-lisp directory in your home directory is known. Create this if it doesn't already exist and then:

  1. Clone the repositories
cd ~/common-lisp && \
git clone https://github.com/Lisp-Stat/plot
  1. From the REPL reset the ASDF source-registry to find the new systems:
    (asdf:clear-source-registry)
    
  2. Load the system
    (asdf:load-system :plot/vglt)
    

If you have installed the slime ASDF extensions, you can invoke this with a comma (',') from the slime REPL.

Getting dependencies

To get the third party systems that these system may depend on you can use a dependency manager, such as Quicklisp or CLPM Once installed, get the dependencies with either of:

(clpm-client:sync :sources "clpi") ;sources may vary
(ql:quickload :plot)

You need do this only once. After obtaining the dependencies, you can load the system with ASDF as described above without first syncing sources.

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 resources and community pages 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


2 Systems

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


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

2.1 plot

Plots for Common Lisp

Author

Steve Nunez <steve@symbolics.tech>

License

MS-PL

Long Description

A plotting system for Common Lisp

Version

1.0

Dependencies
  • lass (system).
  • cl-who (system).
  • cl-ppcre (system).
  • alexandria (system).
Source

plot.asd.

Child Components

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   [Contents][Index]

3.1.1 plot/plot.asd

Source

plot.asd.

Parent Component

plot (system).

ASDF Systems

plot.


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

3.1.2 plot/pkgdcl.lisp

Source

plot.asd.

Parent Component

plot (system).

Packages

plot.


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

3.1.3 plot/init.lisp

Dependency

pkgdcl.lisp (file).

Source

plot.asd.

Parent Component

plot (system).


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

3.1.4 plot/browser.lisp

Dependency

init.lisp (file).

Source

plot.asd.

Parent Component

plot (system).

Public Interface
Internals

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

3.1.5 plot/plot.lisp

Dependency

browser.lisp (file).

Source

plot.asd.

Parent Component

plot (system).

Public Interface

plot-from-file (function).


4 Packages

Packages are listed by definition order.


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

4.1 plot

Source

pkgdcl.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


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

5.1 Public Interface


5.1.1 Special variables

Special Variable: *browser-commands*
Package

plot.

Source

browser.lisp.

Special Variable: *default-browser-command*
Package

plot.

Source

browser.lisp.

Special Variable: *default-browser-options*
Package

plot.

Source

browser.lisp.


5.1.2 Ordinary functions

Function: plot-from-file (filespec &key browser browser-options)

Open plot specification FILESPEC

Package

plot.

Source

plot.lisp.


5.2 Internals


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

5.2.1 Special variables

Special Variable: *default-chrome-options*
Package

plot.

Source

browser.lisp.


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

5.2.2 Ordinary functions

Function: %print-alist (stream data &rest args)
Package

plot.

Source

browser.lisp.

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.

Function: encode-chrome-options (options)

Encode command line options for Chrome

Package

plot.

Source

browser.lisp.

Function: set-chrome-size (size)

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

Package

plot.

Source

browser.lisp.


Appendix A Indexes


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

A.1 Concepts