Author: Kleanthis Koupidis, Aikaterini Chatzopoulou, Charalampos Bratsas

# Using DescriptiveStats.OBeu with OpenCPU

#### Kleanthis Koupidis, Aikaterini Chatzopoulou, Charalampos Bratsas

# Introduction

This document describes the use of the functions implemented in DescriptiveStats.OBeu package in OpenCPU environment, after installing OpenCPU and DescriptiveStats.OBeu package on OpenCPU server address(/ocpu/test).

# How to use functions

- Go to: yourserver/ocpu/test

- Type to the endpoint:

     ../library/ {name of the library} /R/ {function}

- If you want to see the function parameters you should:

  - Select Method: `Get`

- To run a function you should:

  - Select Method: `Post`

- Then you can click on Ajax Request.

# OpenCPU and DescriptiveStats.OBeu

## ds.analysis

In this example we will use `ds.analysis` function that returns in a single call a json string or a list with the following components:

`ds.analysis` components
Component | Output | Description
--- | --- | ---
`statistics` | Min Max Range Mean Median Quantiles Variance StandardDeviation Skewness Kurtosis | The minimum observed value of the input data The maximum observed value of the input data The difference between maximum and minimum The average value of the input data The median value of the input data The 25%, 75% percentiles The variance of the input data The standard deviation of the input data The Skewness of the input data The Kurtosis of the input data
`boxplot` | lo.whisker lo.hinge median up.hinge up.whisker box.width lo.out up.out n | Lower horizontal line out of the box Lower horizontal line of the box Horizontal line in the box Upper horizontal line of the box Upper horizontal line out of the box The box width of each variable Lower outliers Upper outliers The number of non-NA observations
`histogram` | cuts counts mean median | The boundaries of the histogram classes The frequency of each histogram class The average value of the input vector The median value of the input data
`frequencies` | Variable name frequencies "_row" relative.frequencies | The name of the calculated variable The frequency value Name of the categories of the variable Relative frequency values
`correlation` | Variable name Correlation value "_row" | The name of the calculated variable The correlation value The corresponding correlation variable

## Select library and function

1. Go to: yourserver/ocpu/test

2. Copy and paste the following function to the endpoint

    ../library/DescriptiveStats.OBeu/R/ds.analysis
    # library/ {name of the library} /R/ {function}

3. Select Method: `Post`

## Adding parameters parameters

Click add parameters every time you want to add a new parameters and values.

4. Define the input data:

   - Param Name: `data`
   - Param Value: `Wuppertal_df`

5. Define the outliers parameter(optional):

   - Param Name: `outliers`
   - Param Value: `FALSE`

6. Define the fr.select parameter(optional):

   - Param Name: `fr.select`
   - Param Value: `"Produktbereich"`

You add likewise further parameters and change the default parameters of `c.out`, `box.width`, `hist.class`, `corr.method`, see DesciptiveStats.OBeu reference manual for further details.

7. Ready! Click on Ajax request!

## Results

8. copy the /ocpu/tmp/{this_id_number}/R/.val (second on the right panel)

9. finally, paste `yourserver/ocpu/tmp/{this_id_number}/R/.val` on a new tab.

# Further Details

- HTTP in OpenCPU
- OpenCPU Help
- OpenCPU JavaScript Client
- OpenCPU on CRAN

# Github

- OpenCPU package development version
- DescriptiveStats.OBeu package development version