fill_desc.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/desc.R
\name{fill_desc}
\alias{fill_desc}
\title{Fill your \code{DESCRIPTION} file}
\usage{
fill_desc(
  pkg_name,
  pkg_title,
  pkg_description,
  authors = person(given = NULL, family = NULL, email = NULL, role = NULL, comment =
    NULL),
  repo_url = NULL,
  pkg_version = "0.0.0.9000",
  pkg = get_golem_wd(),
  author_first_name = NULL,
  author_last_name = NULL,
  author_email = NULL,
  author_orcid = NULL,
  set_options = TRUE
)
}
\arguments{
\item{pkg_name}{The name of the package}

\item{pkg_title}{The title of the package}

\item{pkg_description}{Description of the package}

\item{authors}{a character string (or vector) of class person
(see \code{\link[=person]{person()}} for details)}

\item{repo_url}{URL (if needed)}

\item{pkg_version}{The version of the package. Default is 0.0.0.9000}

\item{pkg}{Path to look for the DESCRIPTION. Default is \code{get_golem_wd()}.}

\item{author_first_name}{to be deprecated: use character for first name via
\code{authors = person(given = "authors_first_name")} instead}

\item{author_last_name}{to be deprecated: use character for last name via
\code{authors = person(given = "authors_last_name")} instead}

\item{author_email}{to be deprecated: use character for first name via
\code{authors = person(email = "author_email")} instead}

\item{author_orcid}{to be deprecated}

\item{set_options}{logical; the default \code{TRUE} sets all recommended
options but this can be suppressed with \code{FALSE}. For details on the
exact behaviour see the help \code{\link[=set_golem_options]{set_golem_options()}}.}
}
\value{
The \code{{desc}} object, invisibly.
}
\description{
Generates a standard \code{DESCRIPTION} file as used in R packages. Also sets
a series of global options inside \code{golem-config.yml} that will be reused
inside \code{{golem}} (see \code{set_options} and \code{\link[=set_golem_options]{set_golem_options()}} for details).
}