# Quickstart¶

hoggorm is a Python package for explorative multivariate statistics in Python. It contains

- PCA (principal component analysis)
- PCR (principal component regression)
- PLSR (partial least squares regression)
- PLSR1 for single variable responses
- PLSR2 for multivariate responses

- matrix corrlation coefficients RV and RV2.

Unlike scikit-learn, whis is an excellent Python machine learning package focusing on classification and predicition, hoggorm rather aims at understanding and interpretation of the variance in the data. hoggorm also contains tools for prediction.

Note

Results computed with the hoggorm package can be visualised using plotting functions implemented in the complementary hoggormplot package.

## Requirements¶

Make sure that Python 3.5 or higher is installed. A convenient way to install Python and many useful packages for scientific computing is to use the Anaconda distribution.

- numpy

## Installation and updates¶

### Installation¶

Install hoggorm easily from the command line from the PyPI - the Python Packaging Index.

```
pip install hoggorm
```

### Upgrading¶

To upgrade hoggorm from a previously installed older version execute the following from the command line:

```
pip install --upgrade hoggorm
```

If you need more information on how to install Python packages using pip, please see the pip documentation.

## Documentation¶

- Documentation at Read the Docs
- Jupyter notebooks with examples of how to use hoggorm
- for PCA
- for PCR (coming soon)
- for PLSR1 (coming soon)
- for PLSR2 (coming soon)
- for matrix correlation ceoefficitents RV and RV2 (coming soon)

More examples in Jupyter notebooks are provided at hoggormExamples GitHub repository.

## Example¶

```
import hoggorm as ho
# Compute PCA model with
# - 5 components
# - standardised/scaled variables
# - KFold cross validation with 4 folds
model = ho.nipalsPCA(arrX=myData, numComp=5, Xstand=True, cvType=["Kfold", 4])
# Extract results from PCA model
scores = model.X_scores()
loadings = model.X_loadings()
cumulativeCalibratedExplainedVariance_allVariables = model.X_cumCalExplVar_indVar()
cumulativeValidatedExplainedVariance_total = model.X_cumValExplVar()
```

## hoggorm repository on GitHub¶

The source code is available at the hoggorm GitHub repository.