-
Notifications
You must be signed in to change notification settings - Fork 285
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Omit ORCID placeholder from defaults (#2075)
* Stop using placeholder for ORCID identifier * Might as well use a package that usethis depends on here * Re-document and rebuild README
- Loading branch information
Showing
7 changed files
with
14 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,8 +22,7 @@ | |
#' DESCRIPTION file and the user hasn't given any author information via the | ||
#' `fields` argument or the global option `"usethis.description"`. The | ||
#' placeholder looks something like `First Last <[email protected]> [aut, | ||
#' cre] (YOUR-ORCID-ID)` and `use_author()` offers to remove it in interactive | ||
#' sessions. | ||
#' cre]` and `use_author()` offers to remove it in interactive sessions. | ||
#' | ||
#' @inheritParams utils::person | ||
#' @inheritDotParams utils::person | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -124,7 +124,7 @@ usethis_description_defaults <- function(package = NULL) { | |
Version = "0.0.0.9000", | ||
Title = "What the Package Does (One Line, Title Case)", | ||
Description = "What the package does (one paragraph).", | ||
"Authors@R" = 'person("First", "Last", email = "[email protected]", role = c("aut", "cre"), comment = c(ORCID = "YOUR-ORCID-ID"))', | ||
"Authors@R" = 'person("First", "Last", email = "[email protected]", role = c("aut", "cre"))', | ||
License = "`use_mit_license()`, `use_gpl3_license()` or friends to pick a license", | ||
Encoding = "UTF-8" | ||
) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -60,15 +60,15 @@ library(usethis) | |
# Create a new package ------------------------------------------------- | ||
path <- file.path(tempdir(), "mypkg") | ||
create_package(path) | ||
#> ✔ Creating '/tmp/RtmpCJHMlj/mypkg/'. | ||
#> ✔ Setting active project to "/private/tmp/RtmpCJHMlj/mypkg". | ||
#> ✔ Creating '/tmp/RtmpPZsquk/mypkg/'. | ||
#> ✔ Setting active project to "/private/tmp/RtmpPZsquk/mypkg". | ||
#> ✔ Creating 'R/'. | ||
#> ✔ Writing 'DESCRIPTION'. | ||
#> Package: mypkg | ||
#> Title: What the Package Does (One Line, Title Case) | ||
#> Version: 0.0.0.9000 | ||
#> Authors@R (parsed): | ||
#> * First Last <[email protected]> [aut, cre] (YOUR-ORCID-ID) | ||
#> * First Last <[email protected]> [aut, cre] | ||
#> Description: What the package does (one paragraph). | ||
#> License: `use_mit_license()`, `use_gpl3_license()` or friends to pick a | ||
#> license | ||
|
@@ -79,8 +79,8 @@ create_package(path) | |
#> ✔ Setting active project to "<no active project>". | ||
# only needed since this session isn't interactive | ||
proj_activate(path) | ||
#> ✔ Setting active project to "/private/tmp/RtmpCJHMlj/mypkg". | ||
#> ✔ Changing working directory to '/tmp/RtmpCJHMlj/mypkg/' | ||
#> ✔ Setting active project to "/private/tmp/RtmpPZsquk/mypkg". | ||
#> ✔ Changing working directory to '/tmp/RtmpPZsquk/mypkg/' | ||
|
||
# Modify the description ---------------------------------------------- | ||
use_mit_license("My Name") | ||
|
@@ -89,11 +89,11 @@ use_mit_license("My Name") | |
#> ✔ Writing 'LICENSE.md'. | ||
#> ✔ Adding "^LICENSE\\.md$" to '.Rbuildignore'. | ||
|
||
use_package("ggplot2", "Suggests") | ||
#> ✔ Adding ggplot2 to 'Suggests' field in DESCRIPTION. | ||
#> ☐ Use `requireNamespace("ggplot2", quietly = TRUE)` to test if ggplot2 is | ||
use_package("rmarkdown", "Suggests") | ||
#> ✔ Adding rmarkdown to 'Suggests' field in DESCRIPTION. | ||
#> ☐ Use `requireNamespace("rmarkdown", quietly = TRUE)` to test if rmarkdown is | ||
#> installed. | ||
#> ☐ Then directly refer to functions with `ggplot2::fun()`. | ||
#> ☐ Then directly refer to functions with `rmarkdown::fun()`. | ||
|
||
# Set up other files ------------------------------------------------- | ||
use_readme_md() | ||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -31,5 +31,5 @@ | |
v Adding to 'Authors@R' in DESCRIPTION: | ||
Charlie Brown [ctb] | ||
i 'Authors@R' appears to include a placeholder author: | ||
First Last <[email protected]> [aut, cre] (YOUR-ORCID-ID) | ||
First Last <[email protected]> [aut, cre] | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters