Lisp-Stat / Lisp-Stat/documentation

Update basic tutorial

Open
#15 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
HTML
Stars
1
Forks
4
PR merge metrics
No merged PRs in 30d

Description

The basic tutorial has fallen behind the Lisp-Stat project and needs to be updated. In addition to the need for a def/defdf explanation pointed out by @rieser, there are several sections in the documentation that are commented out (you only see this in the documentation source repo because Hugo removes comments from deployed documentation).

Essentially the basic tutorial is the XLisp-Stat tutorial, updated for (Common) Lisp-Stat. At the time of conversion, Lisp-Stat lacked much of the functionality mentioned in the tutorial, so it was commented out. Lisp-Stat has now closed that gap, but the basic tutorial has not kept up.

This would be a good first issue for someone that wants to learn statistics or common lisp.

Originally reported issue:
It would be good to introduce `defdf` somewhere in the Data Frame tutorial. While reading that section, I tried experimenting with my own .csv files, for instance, with `(read-csv my-csv-file-stream) \\ (def results *)`, using what has been introduced so far, and it does give me back a DATA-FRAME object, and I can do a lot of manipulations on it. However, if I try to access `results:my-key`, I get an error, which is extremely confusing. On the other hand, if I use `defdf` instead of `def`, as indicated in the Manual (but not the Tutorial), then `results:my-key` works as expected.

An alternative, of course, would be to extend `def` to handle data frames properly.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the basic tutorial in the documentation source repository, especially the Data Frame tutorial and the sections commented out before Hugo deployment. Compare the tutorial with the Lisp-Stat manual and current functionality, including the defdf explanation. Done means the tutorial reflects available functionality and no longer omits relevant sections.

Written by the indexing model from the issue text.

Assessment

Tech stack
hugo
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.