% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/panoramic-sim.R
\name{panoramic_simulate_dataset}
\alias{panoramic_simulate_dataset}
\title{Simulate a two-group PANORAMIC example dataset}
\usage{
panoramic_simulate_dataset(
  n_group1 = 3L,
  n_group2 = 3L,
  n_cells_group1 = 200L,
  n_cells_group2 = 350L,
  group_labels = c("group1", "group2"),
  scenario_group1 = "random",
  scenario_group2 = "colocalized",
  seed = NULL
)
}
\arguments{
\item{n_group1}{Integer number of samples in group 1.}

\item{n_group2}{Integer number of samples in group 2.}

\item{n_cells_group1}{Integer number of cells per group-1 sample.}

\item{n_cells_group2}{Integer number of cells per group-2 sample.}

\item{group_labels}{Character length-2 vector of group names.}

\item{scenario_group1}{Scenario passed to \code{panoramic_simulate_spe()} for
group 1.}

\item{scenario_group2}{Scenario passed to \code{panoramic_simulate_spe()} for
group 2.}

\item{seed}{Optional integer seed for reproducibility.}
}
\value{
A list with entries \code{spe_list} and \code{design}.
}
\description{
Create a list of \code{SpatialExperiment} objects and matching design table
for differential colocalization tutorials.
}
\examples{
toy <- panoramic_simulate_dataset(seed = 1)
names(toy)
head(toy$design)

}
