Skip to content

Commit

Permalink
rfvip to randomForestVIP
Browse files Browse the repository at this point in the history
  • Loading branch information
KelvynBladen committed Jul 14, 2023
1 parent e2dbac6 commit 5036b8c
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Type: Package
Package: rfvip
Package: randomForestVIP
Title: Tune Random Forests Based on Variable Importance & Plot Results
Version: 0.1.0
Author: Kelvyn Bladen
Expand All @@ -19,7 +19,7 @@ Description: Functions for assessing variable relations and associations
plots. Derivations and methodology are described in Bladen (2022)
<https://digitalcommons.usu.edu/etd/8587/>.
License: GPL-3 + file LICENSE
URL: https://github.com/KelvynBladen/rfvip
URL: https://github.com/KelvynBladen/randomForestVIP
Depends:
R (>= 4.0.0)
Imports:
Expand Down
4 changes: 2 additions & 2 deletions tests/testthat.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
library(testthat)
library(rfvip)
library(randomForestVIP)

test_check("rfvip")
test_check("randomForestVIP")
18 changes: 9 additions & 9 deletions vignettes/Vignette.Rmd
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "rfvip Vignette"
title: "randomForestVIP Vignette"
author: "Kelvyn Bladen"
date: "`r Sys.Date()`"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{rfvip Vignette}
%\VignetteIndexEntry{randomForestVIP Vignette}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---
Expand All @@ -18,7 +18,7 @@ knitr::opts_chunk$set(

## Overview

The goal of `rfvip` is to tune and select a Random Forest model with high
The goal of `randomForestVIP` is to tune and select a Random Forest model with high
accuracy and interpretability. This is done by tuning the Random Forest
based on the accuracy and variable importance metrics associated with each
model. To accomplish this, functions are available to tabulate and plot
Expand Down Expand Up @@ -50,12 +50,12 @@ Applications in R" <https://digitalcommons.usu.edu/etd/8587/>.
## Example: Boston

```{r, warning=FALSE, message=FALSE}
library(rfvip)
library(randomForestVIP)
library(MASS)
library(EZtune)
```

To introduce the functionality of `rfvip`, we look at modeling the Boston
To introduce the functionality of `randomForestVIP`, we look at modeling the Boston
housing data (found in the MASS package). We want to
build a Random Forest model with a view towards both accuracy and
interpretability. We begin by running some preliminary diagnostics on our data.
Expand Down Expand Up @@ -116,17 +116,17 @@ g <- ggvip(m$rf9)$both_vips
The plot above resembles a standard variable importance plot, but possesses
superior tick labels and editing capabilities for the analyst.

We have used the `rfvip` package to tune a strong model for prediction and with
We have used the `randomForestVIP` package to tune a strong model for prediction and with
reasonably useful importance values. This was accomplished by assessing
variable importance and accuracy metrics across the hyper-parameter mtry.

## Example: Lichens in Pacific Northwest

```{r, warning=FALSE, message=FALSE}
library(rfvip)
library(randomForestVIP)
```

To further demonstrate the functionality of `rfvip`, we provide another
To further demonstrate the functionality of `randomForestVIP`, we provide another
example. This time using classification data. We look at modeling the Lichen
data (found in the EZtune package) with a view towards both accuracy and
interpretability. The response is presence or absence (coded 0 or 1) of a
Expand Down Expand Up @@ -203,6 +203,6 @@ using `ggvip`.
g <- ggvip(m$rf33)$both_vips
```

We have used the `rfvip` package to tune a model for prediction and with
We have used the `randomForestVIP` package to tune a model for prediction and with
superior importance values. This was accomplished by assessing variable
importance and accuracy metrics across the hyper-parameter mtry.

0 comments on commit 5036b8c

Please sign in to comment.