% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/stimulus.beeswarm.R
\name{stimulus.beeswarm}
\alias{stimulus.beeswarm}
\title{Make beeswarm plots for compared-stimulus designs}
\usage{
stimulus.beeswarm(
  data,
  dv,
  stimulus,
  condition,
  flip.conditions = FALSE,
  dv.is.percentage = FALSE,
  simtot = 500,
  confidence = 95,
  ylim = c(),
  ylab1 = "",
  ylab2 = "",
  xlab1 = "",
  xlab2 = NULL,
  dot.spacing = "auto",
  col1 = "blue4",
  col2 = "red4",
  main = "",
  watermark = TRUE,
  save.as = "",
  svg.width = "",
  svg.height = "",
  ...
)
}
\arguments{
\item{data}{Data frame containing variables to be analyzed.}

\item{dv}{Name of the dependent variable.}

\item{stimulus}{Name of the variable containing the stimulus ID.}

\item{condition}{Name of the variable containing the condition indicator.}

\item{flip.conditions}{If `TRUE`, reverse the order of condition labels.}

\item{dv.is.percentage}{If `TRUE`, format values as percentages.}

\item{simtot}{Number of bootstraps for the confidence band under homogeneity.}

\item{confidence}{Confidence level for the band (default 95).}

\item{ylim}{Optional y-axis limits.}

\item{ylab1, ylab2}{Labels on the y-axis (optional).}

\item{xlab1, xlab2}{Labels on the x-axis (optional).}

\item{dot.spacing}{Horizontal distance between stimulus labels (`"auto"` by default).}

\item{col1, col2}{Colors for the two conditions.}

\item{main}{Plot title.}

\item{watermark}{If `TRUE`, display package version watermark.}

\item{save.as}{File path for saving the figure (`.svg` or `.png`, optional).}

\item{svg.width}{Optional width when saving.}

\item{svg.height}{Optional height when saving.}

\item{...}{Additional arguments passed to [graphics::plot.default()].}
}
\value{
Invisibly, a two-column matrix of beeswarm coordinates.
}
\description{
Beeswarm plot for compared-stimulus designs from "Stimulus Sampling Reimagined"
(Simonsohn, Montealegre, & Evangelidis, 2024).
}
