-
Notifications
You must be signed in to change notification settings - Fork 12
/
project_create.Rd
66 lines (56 loc) · 1.79 KB
/
project_create.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/project_create.R
\name{project_create}
\alias{project_create}
\title{Create a new project.}
\usage{
project_create(
name,
url = get_default_url(),
un = get_default_un(),
pw = get_default_pw()
)
}
\arguments{
\item{name}{The desired name of the project. Can contain whitespace.}
\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")}.}
}
\value{
A tibble with one row per project and all project metadata
as columns as per ODK Central API docs.
}
\description{
\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}}
}
\examples{
\dontrun{
# See vignette("setup") for setup and authentication options
# ruODK::ru_setup(svc = "....svc", un = "me@email.com", pw = "...")
p <- project_create("Test Project")
knitr::kable(p)
# project_create returns a tibble
class(p)
# > "tbl_df" "tbl" "data.frame"
# columns are project metadata
names(p)
# > "id" "name" "archived"
}
}
\seealso{
\url{https://docs.getodk.org/central-api-project-management/#creating-a-project}
Other project-management:
\code{\link{project_detail}()},
\code{\link{project_list}()}
}
\concept{project-management}