projr_path_get_cache_build.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/dir-get.R
\name{projr_path_get_cache_build_dir}
\alias{projr_path_get_cache_build_dir}
\alias{projr_path_get_cache_build}
\title{Get \code{projr} build cache directory}
\usage{
projr_path_get_cache_build_dir(..., create = FALSE, profile)

projr_path_get_cache_build(..., create = FALSE, profile)
}
\arguments{
\item{...}{comma-separated strings specified initially the
label (e.g. \code{"docs"} or \code{"output"}) as well as, optionally, sub-directories
(e.g. \verb{"img", "}). For example, .path_get_cache_build("docs", "img")\verb{returns the path to the}img\verb{directory in the}docs` sub-directory
of the build cache directory.}

\item{create}{logical.
If \code{TRUE}, then the directory
is created if it does not exist.}

\item{profile}{character.
The name of the \code{projr} profile to use.
Default is \code{NULL}, which uses the current \code{projr} profile.}
}
\value{
character.
Path to the cache (sub-)directory for \code{projr} builds.
}
\description{
Get the cache directory for \code{projr} builds.
It is a sub-directory of the cache directory.
For development builds (.build_dev\verb{), this is the final directory for }output\code{and}docs\verb{ items. For output builds (.build_output}), this is the staging
directory. After the documents are rendered, they are copied
to their final directories.

.path_get_cache_build\verb{ assumes the path is to a file, whereas .path_get_cache_build_dir} assumes the path
is to a directory.
This distinctiion is only relevant when \code{create = TRUE}, as it
determines what directory is attempted to be created.
}
\seealso{
.path_get.path_get_dir
}