% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/datagen-interface.R
\name{recipe_quick_ph}
\alias{recipe_quick_ph}
\title{Quick PH recipe builder}
\usage{
recipe_quick_ph(
  n,
  model = c("ph_exponential", "ph_weibull", "ph_gompertz", "cox_pwexp"),
  baseline,
  treat_effect,
  covariates = list(),
  target_censoring = 0.25,
  allocation = "1:1",
  seed = NULL
)
}
\arguments{
\item{n}{Total sample size (integer).}

\item{model}{PH model. One of \code{"ph_exponential"}, \code{"ph_weibull"},
\code{"ph_gompertz"}, \code{"cox_pwexp"}.}

\item{baseline}{Named list of baseline hazard parameters:
\describe{
\item{ph_exponential}{\code{list(rate = ...)}}
\item{ph_weibull}{\code{list(shape = ..., scale = ...)}}
\item{ph_gompertz}{\code{list(shape = ..., rate = ...)}}
\item{cox_pwexp}{\code{list(rates = c(...), cuts = c(...))}}
}}

\item{treat_effect}{Numeric log-hazard ratio for the treatment arm.}

\item{covariates}{List of covariate definitions. Use \code{\link{covar_continuous}},
\code{\link{covar_binary}}, or \code{\link{covar_categorical}}. Default \code{list()}.}

\item{target_censoring}{Target overall censoring fraction (0-1). Default \code{0.25}.}

\item{allocation}{Treatment allocation ratio string, e.g. \code{"1:1"} (default)
or \code{"1:2"}.}

\item{seed}{Optional seed retained as recipe/provenance metadata. It does not
set the random-number generator.}
}
\value{
A recipe list suitable for \code{\link{simulate_from_recipe}}.
}
\description{
Convenience wrapper that builds a recipe list for proportional-hazard (PH)
models, parallel to \code{\link{recipe_quick_aft}} for AFT models.
The returned recipe is validated and ready for \code{\link{simulate_from_recipe}}.
}
\examples{
r <- recipe_quick_ph(100, "ph_weibull",
       baseline = list(shape = 1.5, scale = 10),
       treat_effect = -0.5,
       covariates = list(covar_continuous("age")),
       target_censoring = 0.30)
set.seed(1)
dat <- simulate_from_recipe(r)

}
\seealso{
\code{\link{recipe_quick_aft}}, \code{\link{rmst.sim}},
\code{\link{simulate_from_recipe}}
}
