Skip to content

Commit

Permalink
Update website, README, citation, etc.
Browse files Browse the repository at this point in the history
  • Loading branch information
jacob-long committed Apr 11, 2022
1 parent 38b22fc commit c99249d
Show file tree
Hide file tree
Showing 25 changed files with 137 additions and 26 deletions.
3 changes: 3 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,6 @@
^_pkgdown\.yml$
^doc$
^Meta$
^make_hex\.R$
^hex\.png$
^LICENSE\.md$
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,5 @@ tests/testthat/Rplots\.pdf
CRAN-RELEASE
doc
Meta

.DS_Store
2 changes: 1 addition & 1 deletion CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at long.1377@osu.edu. All
reported by contacting the project team at jacob.long@sc.edu. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Expand Down
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: interactions
Type: Package
Title: Comprehensive, User-Friendly Toolkit for Probing Interactions
Version: 1.1.5
Version: 1.1.6.9000
Authors@R: person(c("Jacob","A."), "Long", email = "[email protected]",
role = c("aut", "cre"), comment = c(ORCID = "0000-0002-1582-6214"))
Description: A suite of functions for conducting and interpreting analysis
Expand Down
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
YEAR: 2019
COPYRIGHT HOLDER: Jacob Long
YEAR: 2022
COPYRIGHT HOLDER: Jacob A. Long
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# MIT License

Copyright (c) 2022 Jacob A. Long

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
4 changes: 4 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# interactions 1.1.6.9000

* Website and some documentation have been revamped and upgraded.

# interactions 1.1.5

* Made a small change to avoid testing errors in a forthcoming R release.
Expand Down
13 changes: 6 additions & 7 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,18 @@ knitr::opts_chunk$set(
library(jtools)
```

# interactions
# interactions <img src="man/figures/logo.png" alt="interactions" height="250px" align="right" />

[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version-ago/interactions)](https://cran.r-project.org/package=interactions) [![GitHub tag](https://img.shields.io/github/tag/jacob-long/interactions.svg?label=Github)](https://github.com/jacob-long/interactions) [![Total Downloads](https://cranlogs.r-pkg.org/badges/grand-total/interactions)](https://cran.r-project.org/package=interactions)
[![Build Status](https://github.com/jacob-long/interactions/workflows/R-CMD-check/badge.svg)](https://github.com/jacob-long/interactions/actions) [![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/qfyn5cwomufqxath?svg=true)](https://ci.appveyor.com/project/jacob-long/interactions) [![codecov](https://codecov.io/gh/jacob-long/interactions/branch/master/graph/badge.svg)](https://codecov.io/gh/jacob-long/interactions)
<!-- [![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active) [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://opensource.org/licenses/MIT) -->
[![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active) [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://opensource.org/licenses/MIT)

This package consists of a number of tools that pertain to the analysis and
exploration of statistical interactions in the context of regression. Some of
these features, especially those that pertain to visualization, are not exactly
impossible to do oneself but are tedious and error-prone when done "by hand."
Most things in `interactions` were once part of the
[`jtools`](https://jtools.jacob-long.com) package and have
been spun off to this package for clarity and simplicity.
Some parts of `interactions` were once part of the
[`jtools`](https://jtools.jacob-long.com) package.

Quick rundown of features:

Expand Down Expand Up @@ -91,7 +90,7 @@ sim_slopes(fiti, pred = hp, modx = wt, jnplot = TRUE)

The Johnson-Neyman plot can really help you get a handle on what the interval
is telling you, too. Note that you can look at the Johnson-Neyman interval
directly with the `johnson_neyman` function.
directly with the `johnson_neyman()` function.

The above all generalize to three-way interactions, too.

Expand Down Expand Up @@ -119,7 +118,7 @@ interact_plot(fitiris, pred = Petal.Width, modx = Species, plot.points = TRUE)

You may also combine the plotting and simple slopes functions by using
`probe_interaction`, which calls both functions simultaneously. Categorical by
categorical interactions can be investigated using the `cat_plot` function.
categorical interactions can be investigated using the `cat_plot()` function.

## Contributing

Expand Down
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# interactions
# interactions <img src="man/figures/logo.png" alt="interactions" height="250px" align="right" />

[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version-ago/interactions)](https://cran.r-project.org/package=interactions)
[![GitHub
Expand All @@ -13,15 +13,18 @@ Status](https://github.com/jacob-long/interactions/workflows/R-CMD-check/badge.s
[![AppVeyor Build
status](https://ci.appveyor.com/api/projects/status/qfyn5cwomufqxath?svg=true)](https://ci.appveyor.com/project/jacob-long/interactions)
[![codecov](https://codecov.io/gh/jacob-long/interactions/branch/master/graph/badge.svg)](https://codecov.io/gh/jacob-long/interactions)
<!-- [![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active) [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://opensource.org/licenses/MIT) -->
[![Project Status: Active - The project has reached a stable, usable
state and is being actively
developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)
[![MIT
License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://opensource.org/licenses/MIT)

This package consists of a number of tools that pertain to the analysis
and exploration of statistical interactions in the context of
regression. Some of these features, especially those that pertain to
visualization, are not exactly impossible to do oneself but are tedious
and error-prone when done “by hand.” Most things in `interactions` were
once part of the [`jtools`](https://jtools.jacob-long.com) package and
have been spun off to this package for clarity and simplicity.
and error-prone when done “by hand.” Some parts of `interactions` were
once part of the [`jtools`](https://jtools.jacob-long.com) package.

Quick rundown of features:

Expand Down Expand Up @@ -107,7 +110,7 @@ sim_slopes(fiti, pred = hp, modx = wt, jnplot = TRUE)

The Johnson-Neyman plot can really help you get a handle on what the
interval is telling you, too. Note that you can look at the
Johnson-Neyman interval directly with the `johnson_neyman` function.
Johnson-Neyman interval directly with the `johnson_neyman()` function.

The above all generalize to three-way interactions, too.

Expand Down Expand Up @@ -145,7 +148,7 @@ interact_plot(fitiris, pred = Petal.Width, modx = Species, plot.points = TRUE)
You may also combine the plotting and simple slopes functions by using
`probe_interaction`, which calls both functions simultaneously.
Categorical by categorical interactions can be investigated using the
`cat_plot` function.
`cat_plot()` function.

## Contributing

Expand Down
11 changes: 10 additions & 1 deletion _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
template:
bootstrap: 5
params:
bootswatch: readable
bootswatch: litera
bslib:
primary: "#570008"
link-color: "#73000a"
base_font: {google: "Lato"}
font-family-sans-serif: font_google("Lato")
font-family-serif: font_google("Lato")
heading_font: {google: "Raleway"}
code_font: {google: "IBM Plex Mono"}

navbar:
type: inverse
Expand Down
9 changes: 5 additions & 4 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
## Test environments
* Local Windows 10 install, R 4.1.0
* Ubuntu (Trusty) (on Travis-CI), R-release, R-devel
* Local macOS install, R 4.1.3
* ubuntu-latest (via Github Actions), R-release, R-devel, oldrel-1
* macOS-latest (via Github Actions), R-release
* windows-latest (via Github Actions), R-release
* Windows 2012 Server (on Appveyor) R-release, R-devel

## R CMD check results
There is a NOTE regarding my change of email address because I have changed
affiliations since last update.
There were no NOTEs, WARNINGs, or ERRORs.
Binary file added hex.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions inst/CITATION
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
bibentry(
bibtype = "Manual",
title = "interactions: Comprehensive, User-Friendly Toolkit for Probing Interactions",
author = person(c("Jacob","A."), "Long", email = "long.1377@osu.edu",
author = person(c("Jacob","A."), "Long", email = "jacob.long@sc.edu",
role = c("aut", "cre")),
year = "2019",
note = "R package version 1.1.0",
year = "2022",
note = "R package version 1.1.6",
url = "https://cran.r-project.org/package=interactions",
key = "interactions"
)
37 changes: 37 additions & 0 deletions make_hex.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
library(showtext)
library(jtools)
library(interactions)
library(ggplot2)
library(hexSticker)

font_add("Fantasque Sans Mono", "FantasqueSansMono-Regular.ttf")
font_add("monofur", "monof55.ttf")

# states <- as.data.frame(state.x77)
# states$HSGrad <- states$`HS Grad`
# fit <- lm(Income ~ HSGrad + Murder,
# data = states)
# p <- effect_plot(model = fit, pred = Murder, x.label = "x", y.label = "y")

set.seed(1000)
x <- rnorm(1000)
z <- rnorm(1000)
y <- x + z + x*z + rnorm(1000, sd=.1)
d <- data.frame(cbind(x, y, z))
p <- interact_plot(fit <- lm(y ~ x * z, data = d), x, z, colors = "CUD Bright")
p <- p + theme(axis.text.y = element_blank(), axis.text.x = element_blank(),
axis.title.x = element_text(color = "white", size = 5), axis.title.y = element_text(color = "white", size = 5),
panel.grid.major = element_line(linetype='longdash', size = 0.25, color = "#e8e8e8b3"), legend.position = "none") + xlim(-1, 3) +
ylim(-1.75, 5.75)

plot(sticker(p + theme_transparent(), package="interactions", p_family = "Fantasque Sans Mono",
s_width = 1.25, s_height = 1.2, s_x = 0.93, s_y = 0.83, p_size = 4.5, p_y = 1.53, h_color = "#570008",
h_fill = "#844247", url = "interactions.jacob-long.com", u_size = 1.6,
u_family = "Fantasque Sans Mono", filename = "hex.png", dpi = 500))


# atlantic: #466A9F
# garnet: #73000a
# sandstorm: #FFF2E3
# azalea: #844247
# dark garnet: #570008
Binary file added man/figures/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 32 additions & 0 deletions pkgdown/extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
.page-header {
min-height:25px !important;
}

.template-home img.logo {
width: 200px;
}

.text-muted {
color: #ced4da !important;
}

.bg-primary .navbar-nav .nav-link:hover, .bg-primary .navbar-nav .nav-link:hover {
color: #ced4da !important;
}

.huxtable tr, .huxtable th, .huxtable td {
border-style: none;
}

aside h2 {
margin-top: 2rem;
}

.page-header {
margin-top: 2rem;
border-bottom: none;
}

h1, h2, h3, h4 {
font-weight: 400;
}
Binary file added pkgdown/favicon/apple-touch-icon-120x120.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon-152x152.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon-180x180.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon-60x60.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon-76x76.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/favicon-16x16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/favicon-32x32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/favicon.ico
Binary file not shown.

0 comments on commit c99249d

Please sign in to comment.