1
2#' DESCRIPTION fields that denote package dependencies
3#'
4#' Currently it has the following ones: Imports, Depends,
5#' Suggests, Enhances and LinkingTo. See the \emph{Writing R Extensions}
6#' manual for when to use which.
7#'
8#' @family field types
9#' @export
10
11dep_types <- c("Imports", "Depends", "Suggests", "Enhances", "LinkingTo")
12
13standard_fields <- c(
14  "Additional_repositories",
15  "Author",
16  "Authors@R",
17  "Biarch",
18  "BugReports",
19  "BuildKeepEmpty",
20  "BuildManual",
21  "BuildResaveData",
22  "BuildVignettes",
23  "Built",
24  "ByteCompile",
25  "Classification/ACM",
26  "Classification/ACM-2012",
27  "Classification/JEL",
28  "Classification/MSC",
29  "Classification/MSC-2010",
30  "Collate",
31  "Collate.unix",
32  "Collate.windows",
33  "Contact",
34  "Copyright",
35  "Date",
36  "Depends",
37  "Description",
38  "Encoding",
39  "Enhances",
40  "Imports",
41  "KeepSource",
42  "Language",
43  "LazyData",
44  "LazyDataCompression",
45  "LazyLoad",
46  "License",
47  "LinkingTo",
48  "MailingList",
49  "Maintainer",
50  "Note",
51  "OS_type",
52  "Package",
53  "Packaged",
54  "Priority",
55  "Suggests",
56  "SysDataCompression",
57  "SystemRequirements",
58  "Title",
59  "Type",
60  "URL",
61  "Version",
62  "VignetteBuilder",
63  "ZipData",
64  "Repository",
65  "Path",
66  "Date/Publication",
67  "LastChangedDate",
68  "LastChangedRevision",
69  "Revision",
70  "RcmdrModels",
71  "RcppModules",
72  "Roxygen",
73  "Acknowledgements",
74  "Acknowledgments", # USA/Canadian usage.
75  "biocViews"
76)
77
78#' A list of DESCRIPTION fields that are valid according to the CRAN checks
79#'
80#' @family field types
81#' @export
82
83cran_valid_fields <- c(
84  standard_fields,
85  "^(?:X-CRAN|Repository/R-Forge)",
86  paste0(standard_fields, "Note")
87)
88
89#' The DESCRIPTION fields that are supposed to be in plain ASCII encoding
90#'
91#' @family field types
92#' @export
93
94cran_ascii_fields <- c(
95  "Package",
96  "Version",
97  "Priority",
98  "Depends",
99  "Imports",
100  "LinkingTo",
101  "Suggests",
102  "Enhances",
103  "License",
104  "License_is_FOSS",
105  "License_restricts_use",
106  "OS_type",
107  "Archs",
108  "MD5sum",
109  "NeedsCompilation",
110  "Encoding"
111)
112