% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utils-accessors.R
\name{create_addition_template}
\alias{create_addition_template}
\title{Create Additional Data Template}
\usage{
create_addition_template(
  gsea_res,
  output_path = "addition_template_gsealens.csv",
  include_cols = c("Brief_Description", "Custom_Category", "Custom_Tag", "User_Notes")
)
}
\arguments{
\item{gsea_res}{A GseaRes object (generated by \code{batch_calc_gsea}).}

\item{output_path}{Character string specifying the output template file path.
Default: \code{"addition_template_gsealens.csv"}.}

\item{include_cols}{Character vector specifying additional columns to include
besides ID. Default includes standard annotation columns.}
}
\value{
Invisible \code{TRUE} on success.
}
\description{
Generate a template CSV file containing all pathway IDs from
  the GseaRes object. Users can edit this template to add custom annotations
  such as Brief_Description, Custom_Category, Custom_Tag, and User_Notes.
}
\examples{
# Load pre-computed GseaRes shipped with the package and write a template
# CSV to a temporary file (no side effects on the user's filesystem).
data(precomputed_gseares, package = "GSEAlens")

gsea_res <- precomputed_gseares
out_csv <- file.path(tempdir(), "addition_template_demo.csv")
create_addition_template(gsea_res, output_path = out_csv)

# The template contains one row per pathway ID, ready to edit.
template <- utils::read.csv(out_csv)
utils::head(template)
}
