% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/install_blimp.R
\name{install_blimp}
\alias{install_blimp}
\title{Install the Blimp computational engine}
\usage{
install_blimp(dir = NULL, force = FALSE, quiet = FALSE, linux_variant = NULL)
}
\arguments{
\item{dir}{Install directory. Defaults to a hidden, user-writable
per-OS location (\verb{~/.blimp/} on macOS and Linux,
\verb{\%LOCALAPPDATA\%/Blimp/} on Windows), overridable via the \code{R_BLIMP_HOME}
environment variable.}

\item{force}{Logical; overwrite an existing managed install, or proceed
even when a system installation of Blimp is detected. Default \code{FALSE}.
When both managed and system installations exist, the managed install
takes precedence in \code{\link{detect_blimp}}.}

\item{quiet}{Logical; suppress progress messages. Default \code{FALSE}.}

\item{linux_variant}{Optional character; \code{"ubuntu"} or \code{"rhel8"}. When \code{NULL}
(default), the variant is auto-detected from \verb{/etc/os-release}. Ignored on
macOS and Windows.}
}
\value{
Path to the installed \code{blimp} executable, invisibly.
}
\description{
Downloads and installs Blimp into a user-writable directory managed by rblimp.
This is an alternative to installing Blimp via the system installer from
\url{https://www.appliedmissingdata.com/blimp}.
}
\details{
The install directory location can be overridden globally via the
\code{R_BLIMP_HOME} environment variable.

Set \code{R_BLIMP_PREVENT_INSTALL=true} to disable \code{\link{install_blimp}} (intended for
locked-down environments).

Non-interactive R sessions require \code{force = TRUE}.
}
\section{Privacy}{

Calling \code{install_blimp()} contacts \code{updates.blimpstats.com} over HTTPS
to fetch the Blimp engine. Information may be collected as described
in the privacy policy.

See privacy policy: \url{https://www.blimpstats.com/privacy}.
}

\examples{
\dontshow{if (interactive()) withAutoprint(\{ # examplesIf}
\dontrun{
# Install Blimp to the default managed location
install_blimp()

# Install to a custom directory
install_blimp(dir = "~/blimp-managed")

# Force install on a Linux RHEL 8 system without auto-detection
install_blimp(linux_variant = "rhel8")
}
\dontshow{\}) # examplesIf}
}
\seealso{
\code{\link{uninstall_blimp}}, \code{\link{update_blimp}}
}
