survey: This is a Mason template for a generic R package

Description Usage Arguments Format

Description

The template somewhat leans towards GitHub, actually, so it is best for packages developed at GitHub.

Usage

1
2
3
survey

build(answers)

Arguments

answers

The answers the builder operates on.

Format

 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
67
68
69
70
71
72
73
74
List of 18
 $ name           :List of 2
  ..$ expr: language input("Name:", default = basename(getwd()))
  ..$ env :<environment: namespace:mason.rpkg> 
  ..- attr(*, "class")= chr "lazy"
 $ title          :List of 2
  ..$ expr: language input("Title:", default = answers$name)
  ..$ env :<environment: namespace:mason.rpkg> 
  ..- attr(*, "class")= chr "lazy"
 $ version        :List of 2
  ..$ expr: language input("Version:", default = "1.0.0")
  ..$ env :<environment: namespace:mason.rpkg> 
  ..- attr(*, "class")= chr "lazy"
 $ author         :List of 2
  ..$ expr: language input("Author:", default = default_author())
  ..$ env :<environment: namespace:mason.rpkg> 
  ..- attr(*, "class")= chr "lazy"
 $ maintainer     :List of 2
  ..$ expr: language input("Maintainer:", default = default_maintainer(answers))
  ..$ env :<environment: namespace:mason.rpkg> 
  ..- attr(*, "class")= chr "lazy"
 $ description    :List of 2
  ..$ expr: language input("Description:", default = answers$title)
  ..$ env :<environment: namespace:mason.rpkg> 
  ..- attr(*, "class")= chr "lazy"
 $ license        :List of 2
  ..$ expr: language choose("License:", licenses, default = "MIT")
  ..$ env :<environment: namespace:mason.rpkg> 
  ..- attr(*, "class")= chr "lazy"
 $ url            :List of 2
  ..$ expr: language input("URL:", default = default_url(answers))
  ..$ env :<environment: namespace:mason.rpkg> 
  ..- attr(*, "class")= chr "lazy"
 $ bugreports     :List of 2
  ..$ expr: language input("BugReports:", default = default_bugreports(answers))
  ..$ env :<environment: namespace:mason.rpkg> 
  ..- attr(*, "class")= chr "lazy"
 $ testing        :List of 2
  ..$ expr: language choose("Testing framework:", choices = c("testthat", "none"), default = 1)
  ..$ env :<environment: namespace:mason.rpkg> 
  ..- attr(*, "class")= chr "lazy"
 $ readme         :List of 2
  ..$ expr: language confirm("README.md file:", default = TRUE)
  ..$ env :<environment: namespace:mason.rpkg> 
  ..- attr(*, "class")= chr "lazy"
 $ readme_rmd     :List of 2
  ..$ expr: language confirm("README.Rmd file:", default = TRUE, when = function(a) a$readme)
  ..$ env :<environment: namespace:mason.rpkg> 
  ..- attr(*, "class")= chr "lazy"
 $ news           :List of 2
  ..$ expr: language confirm("NEWS.md file:", default = TRUE)
  ..$ env :<environment: namespace:mason.rpkg> 
  ..- attr(*, "class")= chr "lazy"
 $ cis            :List of 2
  ..$ expr: language checkbox("Continuous integration:", choices = cis, default = c("Travis",      "Appveyor"))
  ..$ env :<environment: namespace:mason.rpkg> 
  ..- attr(*, "class")= chr "lazy"
 $ create_git_repo:List of 2
  ..$ expr: language confirm("Create git repo?", default = TRUE)
  ..$ env :<environment: namespace:mason.rpkg> 
  ..- attr(*, "class")= chr "lazy"
 $ create_gh_repo :List of 2
  ..$ expr: language confirm("Create repo on GitHub?", default = TRUE, when = function(a) a$create_git_repo)
  ..$ env :<environment: namespace:mason.rpkg> 
  ..- attr(*, "class")= chr "lazy"
 $ gh_username    :List of 2
  ..$ expr: language input("GitHub username:", default = whoami::gh_username(), when = function(a) a$create_git_repo &&      a$create_gh_repo)
  ..$ env :<environment: namespace:mason.rpkg> 
  ..- attr(*, "class")= chr "lazy"
 $ push_to_github :List of 2
  ..$ expr: language confirm("Push initial version to GitHub?", default = FALSE, when = function(a) a$create_gh_repo)
  ..$ env :<environment: namespace:mason.rpkg> 
  ..- attr(*, "class")= chr "lazy"
 - attr(*, "class")= chr "ask_questions"

metacran/mason.rpkg documentation built on May 22, 2017, 4:23 a.m.