% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/global.R
\name{dbMatrix_options}
\alias{dbMatrix_options}
\alias{dbMatrix-options}
\title{dbMatrix Package Global Options}
\value{
No return value. This documentation page describes package options.
}
\description{
The following global options can be modified to control the
behavior of the \code{\link{dbMatrix}} package.
}
\details{
Use \code{options()} to set the below options.
}
\section{Options}{

\itemize{
\item \code{dbMatrix.digits}: integer. Number of digits to round to in the show
function of dbMatrix objects. Default is 7.
\item \code{dbMatrix.max_mem_convert}: numeric. Maximum size (in bytes) allowed for
implicit conversion of \code{dbMatrix} to in-memory matrix. Default is 8 * 1024^3 (8GB).
\item \code{dbMatrix.chunk_size}: integer. Number of columns to process per chunk during
densification (\code{.to_db_dense}). Smaller chunks reduce memory usage but may increase
execution time. Default is \code{NULL} (automatically calculated based on \code{dbMatrix.max_mem_convert}).
\item \code{dbMatrix.max_chunks}: integer. Maximum number of chunks allowed during
densification. This prevents query parser errors caused by excessive \verb{UNION ALL}
branches. Default is 10000.
\item \code{dbMatrix.verbose}: logical. If \code{TRUE} (default), prints informative messages
during implicit coercion.
\item \code{dbMatrix.precomp_db}: character. Path to an external DuckDB file containing
precomputed table(s). If set, \code{dbMatrix} will automatically attach this
database (read-only) and look for a suitable precomputed table to speed up densification.
\item \code{dbMatrix.allow_densify}: logical. If \code{FALSE} (default), automatic sparse-to-dense
conversion is disabled. This prevents unexpected disk spilling and memory issues
when operations would require densification (e.g., division by zero, scalar addition
to sparse matrix). Set to \code{TRUE} to enable on-disk dense conversion. \strong{Warning}:
Dense conversion can cause massive disk usage for large matrices.
}
}

