create_golem.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/create_golem.R
\name{create_golem}
\alias{create_golem}
\title{Create a package for a Shiny App using \code{{golem}}}
\usage{
create_golem(
  path,
  check_name = TRUE,
  open = TRUE,
  overwrite = FALSE,
  package_name = basename(normalizePath(path, mustWork = FALSE)),
  without_comments = FALSE,
  project_hook = golem::project_hook,
  with_git = FALSE,
  ...
)
}
\arguments{
\item{path}{Name of the folder to create the package in.
This will also be used as the package name.}

\item{check_name}{Should we check that the package name is
correct according to CRAN requirements.}

\item{open}{Boolean. Open the created project?}

\item{overwrite}{Boolean. Should the already existing project be overwritten ?}

\item{package_name}{Package name to use. By default, \code{{golem}} uses
\code{basename(path)}. If \code{path == '.'} & \code{package_name} is
not explicitly set, then \code{basename(getwd())} will be used.}

\item{without_comments}{Boolean. Start project without \code{{golem}} comments}

\item{project_hook}{A function executed as a hook after project
creation. Can be used to change the default \code{{golem}} structure.
to override the files and content. This function is executed just
after the project is created.}

\item{with_git}{Boolean. Initialize git repository}

\item{...}{Arguments passed to the \code{project_hook()} function.}
}
\value{
The path, invisibly.
}
\description{
Create a package for a Shiny App using \code{{golem}}
}
\note{
For compatibility issue, this function turns \code{options(shiny.autoload.r)}
to \code{FALSE}. See https://github.com/ThinkR-open/golem/issues/468 for more background.
}