A statistical computing environment for Common Lisp

lisp-stat

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MS-PL License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]




<br />
<p align="center">
  <a href="https://github.com/lisp-stat/lisp-stat">
    <img src="https://lisp-stat.dev/images/stats-image.svg" alt="Logo" width="80" height="80">
  </a>

  <h3 align="center">Lisp-Stat</h3>

  <p align="center">
	An environment for statistical computing
	<br />
    <a href="https://lisp-stat.dev/docs/"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://github.com/lisp-stat/lisp-stat/issues">Report Bug</a>
    ·
    <a href="https://github.com/lisp-stat/lisp-stat/issues">Request Feature</a>
    ·
    <a href="https://lisp-stat.github.io/lisp-stat/">Reference Manual</a>
  </p>
</p>




<details open="open">
  <summary><h2 style="display: inline-block">Table of Contents</h2></summary>
  <ol>
    <li>
      <a href="#about-the-project">About the Project</a>
      <ul>
        <li><a href="#built-with">Built With</a></li>
      </ul>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#prerequisites">Prerequisites</a></li>
        <li><a href="#installation">Installation</a></li>
      </ul>
    </li>
    <li><a href="#usage">Usage</a></li>
    <li><a href="#roadmap">Roadmap</a></li>
	<li><a href="#resources">Resources</a></li>
    <li><a href="#contributing">Contributing</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#contact">Contact</a></li>
  </ol>
</details>




## About the Project

  Lisp-Stat provides support for vectorized mathematical operations,
  and a comprehensive set of statistical methods that are implemented
  using the latest numerical algorithms.  In addition, Common Lisp
  provides a dynamic programming environment
  ([REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop)),
  an excellent object-oriented facility
  ([CLOS](https://en.wikipedia.org/wiki/Common_Lisp_Object_System))
  and meta-object protocol
  ([MOP](https://en.wikipedia.org/wiki/Metaobject#Metaobject_protocol)).

   Lisp-Stat is fully functional today, and most of the [XLISP-STAT
   libraries](https://github.com/Lisp-Stat/xls-archive) can be ported
   with the aid of a compatibility package
   [XLS-compat](https://github.com/Lisp-Stat/XLS-compat).  This gives
   Lisp-Stat a leg up on ecosystem development.


### Built With

* [data-frame](https://github.com/Lisp-Stat/data-frame)
* [dfio](https://github.com/Lisp-Stat/dfio)
* [numerical-utilities](https://github.com/Lisp-Stat/numerical-utilities)
* [special-functions](https://github.com/Lisp-Stat/special-functions)
* [array-operations](https://github.com/Lisp-Stat/array-operations)
* [let-plus](https://github.com/sharplispers/let-plus)



## Getting Started

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

### Prerequisites

An ANSI Common Lisp implementation. Developed and tested with
[SBCL](https://www.sbcl.org/) ~~and
[CCL](https://github.com/Clozure/ccl)~~.

Note: CCL is in poor condition these days, and we no can longer support it due to some serious problem with numerical accuracy. See [issue 390](https://github.com/Clozure/ccl/issues/390) for just one of the problems. A shame, because it's a great environment to work in.

### Installation

Lisp-Stat is composed of several systems that are designed to be
independently useful.  So you can, for example, use
[select](https://github.com/Lisp-Stat/select) to obtain selections
from two dimensional arrays without bringing in all of Lisp-Stat.

#### The easy way

Quicklisp has many dependencies, and the easiest way to load it is with a package manager, such as [Quicklisp](https://www.quicklisp.org/beta/) or [CLPM](https://www.clpm.dev/).  The install is a one-liner:

```lisp
(clpm-client:sync :sources "clpi") ;sources may vary
```

```lisp
(ql:quickload :lisp-stat)
```

#### From source

To make the system accessible to [ASDF](https://common-lisp.net/project/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
```sh
cd ~/common-lisp && \
git clone https://github.com/Lisp-Stat/data-frame.git && \
git clone https://github.com/Lisp-Stat/dfio.git && \
git clone https://github.com/Lisp-Stat/special-functions.git && \
git clone https://github.com/Lisp-Stat/numerical-utilities.git && \
git clone https://github.com/Lisp-Stat/array-operations.git && \
git clone https://github.com/Lisp-Stat/documentation.git && \
git clone https://github.com/Lisp-Stat/distributions.git && \
git clone https://github.com/Lisp-Stat/plot.git && \
git clone https://github.com/Lisp-Stat/select.git && \
git clone https://github.com/Lisp-Stat/cephes.cl.git && \
git clone https://github.com/Symbolics/alexandria-plus && \
git clone https://github.com/Lisp-Stat/statistics.git && \
git clone https://github.com/Lisp-Stat/lisp-stat.git
```
2. Reset the ASDF source-registry to find the new system (from the REPL)
   ```lisp
   (asdf:clear-source-registry)
   ```
3. Load the system
   ```lisp
   (asdf:load-system :lisp-stat)
   ```

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

You'll need to use Quicklisp, CLPM or manually obtain the remaining third-party dependencies.

### Running Tests

To run the `lisp-stat` tests, evaluate this form: `(asdf:test-system :lisp-stat)`



## Usage

Create a data frame from a file named `sg-weather.csv` on the local disk:

```lisp
(defparameter *df*
	(read-csv #P"LS:DATA;sg-weather.csv"))

```

For more examples, please refer to the
[Documentation](https://lisp-stat.dev/docs/).



## Roadmap

See the [open issues](https://github.com/lisp-stat/lisp-stat/issues) for a list of proposed features (and known issues).

## Resources

This system is part of the [Lisp-Stat](https://lisp-stat.dev/) project; that should be your first stop for information. Also see the 
[community](https://lisp-stat.dev/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](CONTRIBUTING.md) for details on the code of conduct, and the process for submitting pull requests.


## License

Distributed under the MS-PL License. See [LICENSE](LICENSE) for more information.




## Contact

Project Link: [https://github.com/lisp-stat/lisp-stat](https://github.com/lisp-stat/lisp-stat)





[contributors-shield]: https://img.shields.io/github/contributors/lisp-stat/lisp-stat.svg?style=for-the-badge
[contributors-url]: https://github.com/lisp-stat/lisp-stat/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/lisp-stat/lisp-stat.svg?style=for-the-badge
[forks-url]: https://github.com/lisp-stat/lisp-stat/network/members
[stars-shield]: https://img.shields.io/github/stars/lisp-stat/lisp-stat.svg?style=for-the-badge
[stars-url]: https://github.com/lisp-stat/lisp-stat/stargazers
[issues-shield]: https://img.shields.io/github/issues/lisp-stat/lisp-stat.svg?style=for-the-badge
[issues-url]: https://github.com/lisp-stat/lisp-stat/issues
[license-shield]: https://img.shields.io/github/license/lisp-stat/lisp-stat.svg?style=for-the-badge
[license-url]: https://github.com/lisp-stat/lisp-stat/blob/master/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/company/symbolics/

alexandria

array-operations

cl-semver

data-frame

dfio

num-utils

select

split-sequence

cl-ascii-table

cl-csv

dexador

make-hash

API for manipulating data sets from R packages

Load Rdatasets from github into a data structure and provide access functions. See https://github.com/vincentarelbundock/Rdatasets/tree/master/csv

lisp-stat/rdata

parachute

lisp-stat/tests

lisp-stat

Upstream URL

Author

License

lisp-stat

Version:

License:

Authors:

Dependencies:

lisp-stat/rdata

License:

Authors:

Dependencies:

lisp-stat/tests

License:

Authors:

Dependencies:

Dependencies (11)

Dependents (1)