Skip to content

Commit

Permalink
Docs: update README.md to include validation example
Browse files Browse the repository at this point in the history
  • Loading branch information
mihaiconstantin committed Aug 10, 2021
1 parent fd3304e commit 8f0d932
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,14 @@ results <- powerly(
)
```

To validate the results of the analysis, we can use the `validate()` method.
For more information, see the documentation `?validate`.

```r
# Validate the recommendation obtained during the analysis.
validation <- validate(results)
```

To visualize the results, we can use the `plot` function and indicating the
step that should be plotted.

Expand Down Expand Up @@ -109,6 +117,15 @@ plot(results, step = 3)
<img width = "50%" src="./man/figures/example-step-3.svg" alt="Example Step 3"/>
</p>

```r
# Validation.
plot(validation)
```

<p align="center">
<img width = "50%" src="./man/figures/example-validation.svg" alt="Example Validation"/>
</p>

---

## Contributing
Expand Down

0 comments on commit 8f0d932

Please sign in to comment.