% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/project_detail.R
\name{project_detail}
\alias{project_detail}
\title{List all details of one project.}
\usage{
project_detail(
  pid = get_default_pid(),
  url = get_default_url(),
  un = get_default_un(),
  pw = get_default_pw(),
  retries = get_retries()
)
}
\arguments{
\item{pid}{The numeric ID of the project, e.g.: 2.

Default: \code{\link{get_default_pid}}.

Set default \code{pid} through \code{ru_setup(pid="...")}.

See \code{vignette("Setup", package = "ruODK")}.}

\item{url}{The ODK Central base URL without trailing slash.

Default: \code{\link{get_default_url}}.

Set default \code{url} through \code{ru_setup(url="...")}.

See \code{vignette("Setup", package = "ruODK")}.}

\item{un}{The ODK Central username (an email address).
Default: \code{\link{get_default_un}}.
Set default \code{un} through \code{ru_setup(un="...")}.
See \code{vignette("Setup", package = "ruODK")}.}

\item{pw}{The ODK Central password.
Default: \code{\link{get_default_pw}}.
Set default \code{pw} through \code{ru_setup(pw="...")}.
See \code{vignette("Setup", package = "ruODK")}.}

\item{retries}{The number of attempts to retrieve a web resource.

This parameter is given to \code{\link[httr]{RETRY}(times = retries)}.

Default: 3.}
}
\value{
A tibble with exactly one row for the project and all project
metadata as columns as per ODK Central API docs.
Column names are renamed from ODK's \code{camelCase} to \code{snake_case}.
Values differ to values returned by ODK Central API:
\itemize{
\item archived: FALSE (if NULL) else TRUE
\item dates: NA if NULL
}
}
\description{
While the API endpoint will return all details for one project,
\code{\link{project_detail}} will fail with incorrect or missing
authentication.
}
\details{
\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}}
}
\examples{
\dontrun{
# See vignette("setup") for setup and authentication options
# ruODK::ru_setup(svc = "....svc", un = "me@email.com", pw = "...")

pd <- project_detail()

pd \%>\%
  dplyr::select(-"verbs") \%>\%
  knitr::kable(.)
}
}
\seealso{
\url{https://docs.getodk.org/central-api-project-management/#getting-project-details}

Other project-management: 
\code{\link{project_create}()},
\code{\link{project_list}()}
}
\concept{project-management}
