Skip to content

Commit

Permalink
fix #81 note in tag_create that only sysadmins can use it
Browse files Browse the repository at this point in the history
update servers() man file
  • Loading branch information
sckott committed Jul 3, 2019
1 parent c39cf29 commit 07b7f46
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 9 deletions.
13 changes: 9 additions & 4 deletions R/tag_create.R
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
#' Create a tag
#'
#' IMPORTANT: You must be a sysadmin to create vocabulary tags.
#'
#' @export
#'
#' @param name (character) The name for the new tag, a string between 2 and 100
#' characters long containing only alphanumeric characters and -, _ and ., e.g. 'Jazz'
#' @param vocabulary_id (character) The id of the vocabulary that the new tag should be
#' added to, e.g. the id of vocabulary 'Genre'
#' characters long containing only alphanumeric characters and -, _ and .,
#' e.g. 'Jazz'
#' @param vocabulary_id (character) The id of the vocabulary that the new
#' tag should be added to, e.g. the id of vocabulary 'Genre'
#' @template args
#' @template key
#' @examples \dontrun{
#' ckanr_setup(url = "https://demo.ckan.org/",
#' key = Sys.getenv("CKAN_DEMO_KEY"))
#' tag_create(name = "TestTag1", vocabulary_id = "Testing1")
#' }
tag_create <- function(name, vocabulary_id,
key = get_default_key(), url = get_default_url(), as = 'list', ...) {
key = get_default_key(), url = get_default_url(), as = 'list', ...) {

warning("not tested yet, may not work", call. = FALSE)
body <- cc(list(name = name, vocabulary_id = vocabulary_id))
Expand Down
1 change: 0 additions & 1 deletion man/servers.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 7 additions & 4 deletions man/tag_create.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 07b7f46

Please sign in to comment.