Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add installation instructions #715

Merged
merged 5 commits into from
Aug 22, 2023
Merged

Add installation instructions #715

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d7a91c6
Add installation instructions
logankilpatrick Sep 6, 2021
b326034
Update header
logankilpatrick Sep 6, 2021
34b97fb
Update docs/src/index.md
ParadaCarleton Aug 22, 2023
686064e
Update docs/src/index.md
ParadaCarleton Aug 22, 2023
7f18786
Update docs/src/index.md
ParadaCarleton Aug 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# StatsBase.jl Documentation
# Getting Started
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Getting Started" doesn't sound appropriate given that this page essentially gives the table of contents. I'd keep the existing name.


```@meta
CurrentModule = StatsBase
Expand All @@ -10,6 +10,21 @@ end

*StatsBase.jl* is a Julia package that provides basic support for statistics. Particularly, it implements a variety of statistics-related functions, such as scalar statistics, high-order moment computation, counting, ranking, covariances, sampling, and empirical density estimation.

## Installation

To install StatsBase through the Julia REPL, you can type `] add StatsBase` or:

ParadaCarleton marked this conversation as resolved.
Show resolved Hide resolved
```julia
using Pkg
Pkg.add("StatsBase")
```
To load the package, use the command:

ParadaCarleton marked this conversation as resolved.
Show resolved Hide resolved
```
using StatsBase
```

## Available methods
ParadaCarleton marked this conversation as resolved.
Show resolved Hide resolved

```@contents
Pages = ["weights.md", "scalarstats.md", "robust.md", "deviation.md", "cov.md", "counts.md", "ranking.md", "sampling.md", "empirical.md", "signalcorr.md", "misc.md", "statmodels.md", "transformations.md"]
Expand Down