Skip to content

Commit

Permalink
vignette update pre-merge
Browse files Browse the repository at this point in the history
  • Loading branch information
jluchman committed May 4, 2024
1 parent 7e893bb commit 0933fe5
Show file tree
Hide file tree
Showing 6 changed files with 150 additions and 103 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: domir
Title: Tools to Support Relative Importance Analysis
Version: 1.2.0
Date: 2024-4-14
Date: 2024-5-4
Authors@R:
person(given = "Joseph",
family = "Luchman",
Expand Down
4 changes: 2 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ domir(mpg ~ am + vs + cyl, lm_wrapper, data = mtcars)

`domir` requires the set of inputs/names, submitted as a `formula` or a specialized [`formula_list`](https://jluchman.github.io/domir/reference/formula_list.html) object, and a function that accepts the input/names and returns a single, numeric value.

Note the use of a wrapper function, `lm_wrapper`, that accepts a `formula` and returns the $R^2$. These 'analysis pipeline' wrapper functions are necessary for the effective use of `domir` and underlies the package's flexibility.
Note the use of a wrapper function, `lm_wrapper`, that accepts a `formula` and returns the $R^2$. These 'analysis pipeline' wrapper functions are necessary for the effective use of `domir` and the ability to use them to adapt predictive models to the computational engine used by `domir` makes this package able to apply to almost any model.

`domir` by default reports on complete dominance proportions, conditional dominance values, and general dominance values.

Expand All @@ -62,7 +62,7 @@ General dominance values are the average value associated with the name across a

# Comparison with Existing Relative Importance Packages

Several other relative importance packages can produce results identical to `domir` under specific circumstances. I will focus on discussing two of the most directly re
Several other relative importance packages can produce results identical to `domir` under specific circumstances. I will focus on discussing two of the most relevant comparison packages below.

The `calc.relimpo` function in the **relaimpo** package with `type = "lmg"` produces the general dominance values for `lm` as in the example below:

Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,9 @@ single, numeric value.

Note the use of a wrapper function, `lm_wrapper`, that accepts a
`formula` and returns the $R^2$. These ‘analysis pipeline’ wrapper
functions are necessary for the effective use of `domir` and underlies
the package’s flexibility.
functions are necessary for the effective use of `domir` and the ability
to use them to adapt predictive models to the computational engine used
by `domir` makes this package able to apply to almost any model.

`domir` by default reports on complete dominance proportions,
conditional dominance values, and general dominance values.
Expand All @@ -112,7 +113,7 @@ Value](https://en.wikipedia.org/wiki/Shapley_value) for each name.

Several other relative importance packages can produce results identical
to `domir` under specific circumstances. I will focus on discussing two
of the most directly re
of the most relevant comparison packages below.

The `calc.relimpo` function in the **relaimpo** package with
`type = "lmg"` produces the general dominance values for `lm` as in the
Expand Down
33 changes: 16 additions & 17 deletions man/domir.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 0933fe5

Please sign in to comment.