Version: 0.1.1053

Minor fixes that may have documentation problems

Author: antaldaniel

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: wbdataset
 Title: Making Datasets Truly Interoperable and Reusable in R with Wikibase
-Version: 0.1.1053
-Date: 2024-06-06
+Version: 0.1.1056
+Date: 2024-06-08
 Authors@R: 
     c(person(given="Daniel", family="Antal", 
            email= "[email protected]", 

R/add_id_statement.R

@@ -1,6 +1,6 @@
 #' @rdname add_statement
 #' @description See
-#' \link[https://www.wikidata.org/w/api.php?action=help&modules=wbcreateclaim]{MediaWiki
+#' \href{https://www.wikidata.org/w/api.php?action=help&modules=wbcreateclaim}{MediaWiki
 #' API help}
 #' @param qid The QID of the item in the Wikibase instance that you use.
 #' @param pid The PID of the equivalent Wikidata (or reference Wikibase) URI.
@@ -9,8 +9,8 @@
 #' @param wikibase_api_url The full URL of the Wikibase API, which is the
 #'   address that the \code{wbdataset} R client sends requests to when
 #'   interacting with the knowledge base. For example,
-#'   \code{'https://reprexbase.eu/demowiki/api.php'}. The URL must end with
-#'   api.php.
+#'   \code{'https://reprexbase.eu/demowiki/api.php'}.
+#'   The URL must end with api.php.
 #' @param csrf The CSRF token of your session, received with
 #'   \code{\link{get_csrf}}.
 #' @importFrom httr POST content
@@ -25,8 +25,14 @@ add_id_statement <- function(
     wikibase_api_url = "https://reprexbase.eu/demowiki/api.php",
     csrf) {
 
-  datavalue <- paste0('"', o, '"')
-  datavalue
+  format_claim_value <- function(value, datatype) {
+    if (datatype %in% c("external-id", "string", "url")) {
+      return(paste0('"', value, '"'))
+    }
+    stop("Unsupported datatype")
+  }
+
+  datavalue <- format_claim_value(o, wikibase_type)
 
   this_csrf_token <- get_csrf_token(csrf = csrf)
 
@@ -67,21 +73,17 @@ add_id_statement <- function(
     return(data.frame(
       id = NA_character_,
       s = qid,
-      o = NA_character_,
-      p = NA_character_
+      p = NA_character_,
+      o = NA_character_
     ))
   }
 
   if (response$success == 1) {
     data.frame(
       id = response$claim$id,
       s = qid,
-      o = pid,
-      p = response$claim$mainsnak$datavalue$value
+      p = pid,
+      o = response$claim$mainsnak$datavalue$value
     )
   }
 }
-
-
-#' datavalue\":{\"value\":\"https://www.wikidata.org/wiki/Q43878\",\"type\":\"string\"},\"datatype\":\"external-id\"}'
-# api.php?action=wbcreateclaim&entity=Q4115189&property=P9003&snaktype=value&value={"entity-type":"item","numeric-id":1}

R/add_statement.R

@@ -1,7 +1,7 @@
 #' @title Add statements to an item
 #' @description Adds a claim (statement) to a Wikibase item via `wbcreateclaim`.
 #' See
-#' \link[https://www.wikidata.org/w/api.php?action=help&modules=wbcreateclaim]{MediaWiki
+#' \href{https://www.wikidata.org/w/api.php?action=help&modules=wbcreateclaim}{MediaWiki
 #' API help}
 #' @param qid The QID of the item in the Wikibase instance.
 #' @param pid The PID of the property to be added.
@@ -14,7 +14,7 @@
 #' @export
 add_statement <- function(
     qid, pid, o,
-    wikibase_type = c("item", "string", "numeric", "external-id"),
+    wikibase_type = c("item", "string", "numeric", "external-id", "url"),
     wikibase_api_url = "https://reprexbase.eu/demowiki/api.php",
     csrf) {
 
@@ -26,11 +26,12 @@ add_statement <- function(
   wikibase_type <- match.arg(wikibase_type,
     choices = c(
       "item", "string",
-      "numeric", "external-id"
+      "numeric", "external-id", "url"
     )
   )
 
   if (wikibase_type == "external-id") wikibase_type <- "string"
+  if (wikibase_type == "url") wikibase_type <- "string"
 
   if (wikibase_type == "string") {
     add_id_statement(

R/check_existing_item.R

@@ -17,6 +17,19 @@
 #'   adhering to BCP 47 standards (e.g., `"en"` for English). Defaults to
 #'   `"en"`. For more details, see \href{https://tools.ietf.org/html/bcp47}{BCP
 #'   47}.
+#' @param classification_property The instance of, or subclass of, or superclass
+#'   of property. Defaults to \code{NA_character} when not used.
+#' @param classification_id The QID of the class. Defaults to
+#'   \code{NA_character} when not used.
+#' @param equivalence_property An optional PID of a property already defined in
+#'   the same Wikibase instance that records the equivalence of this new
+#'   item with a property defined elsewhere, for example, on Wikidata or
+#'   CIDOC-CRM. Defaults to \code{NA_character_}; if left missing, no
+#'   equivalence relations is will be claimed.
+#' @param equivalence_id The identifier that uniquely identifies this item among
+#' another system's definitions. Defaults to
+#'   \code{NA_character_}; if left missing, no equivalence relations is will be
+#'   claimed.
 #' @param action A character string indicating the action being performed.
 #'   Defaults to `"create_item"`.
 #' @param log_file_name A character string specifying the name of the log file.
@@ -42,18 +55,19 @@
 #' )
 #' @export
 
-check_existing_item <- function(search_term,
-                                language = "en",
-                                equivalence_property = NA_character_,
-                                equivalence_id = NA_character_,
-                                classification_property = NA_character_,
-                                classification_id = NA_character_,
-                                action = "create_item",
-                                log_file_name = NA_character_,
-                                data_curator = person("Unknown", "Person"),
-                                wikibase_api_url = "https://www.wikidata.org/w/api.php",
-                                csrf = NULL,
-                                ambiguity_handling = "return_null") {
+check_existing_item <- function(
+    search_term,
+    language = "en",
+    equivalence_property = NA_character_,
+    equivalence_id = NA_character_,
+    classification_property = NA_character_,
+    classification_id = NA_character_,
+    action = "create_item",
+    log_file_name = NA_character_,
+    data_curator = person("Unknown", "Person"),
+    wikibase_api_url = "https://www.wikidata.org/w/api.php",
+    csrf = NULL,
+    ambiguity_handling = "return_null") {
   # Validate inputs
   if (!is.character(search_term) ||
       length(search_term) != 1 ||

R/check_existing_property.R

@@ -6,9 +6,24 @@
 #'   action=wbsearchentities}.
 #' @param search_term A character string specifying the label to search for. For
 #'   example, "instance of".
+#' @param action A name for the action performed by a function for the
+#' log file, defaults to \code{"create_property"}.
 #' @param language A character string specifying the language code of the label,
 #'   adhering to BCP 47 standards (e.g., `"en"` for English). Defaults to
 #'   `"en"`.
+#' @param classification_property The instance of, or subclass of, or superclass
+#'   of property. Defaults to \code{NA_character} when not used.
+#' @param classification_id The QID of the class. Defaults to
+#'   \code{NA_character} when not used.
+#' @param equivalence_property An optional PID of a property already defined in
+#'   the same Wikibase instance that records the equivalence of this new
+#'   item with a property defined elsewhere, for example, on Wikidata or
+#'   CIDOC-CRM. Defaults to \code{NA_character_}; if left missing, no
+#'   equivalence relations is will be claimed.
+#' @param equivalence_id The identifier that uniquely identifies this item among
+#' another system's definitions. Defaults to
+#'   \code{NA_character_}; if left missing, no equivalence relations is will be
+#'   claimed.
 #' @param wikibase_api_url The full URL of the Wikibase API. Defaults to
 #'   `'https://www.wikidata.org/w/api.php'`, which is Wikidata's API endpoint.
 #' @param csrf The CSRF token of your session, obtained with
@@ -19,6 +34,13 @@
 #'   where multiple properties match the search term. Options are
 #'   \code{"return_first"} (default) to return the first match, or
 #'   \code{"return_null"} to return \code{NULL} when multiple matches are found.
+#' @param log_file_name An explicitly stated full path to a possible CSV log
+#'   file, defaults to \code{NULL}. If the value is \code{NULL}, no log file
+#'   will be created.
+#' @param data_curator The name of the data curator who runs the function and
+#'   creates the log file, created with \link[utils]{person}.
+#'   It is either given as a parameter or resolved from
+#'   \code{wikibase_session}. If no curator
 #' @return A data frame containing details of the matching property, or
 #'   \code{NULL} if no match is found or if multiple matches are found and
 #'   \code{ambiguity_handling} is set to \code{"return_null"}.

R/copy_wikidata_property.R

@@ -23,6 +23,15 @@
 #'   of property. Defaults to \code{NA_character} when not used.
 #' @param classification_id The QID of the class. Defaults to
 #'   \code{NA_character} when not used.
+#' @param equivalence_property An optional PID of a property already defined in
+#'   the same Wikibase instance that records the equivalence of this new
+#'   item with a property defined elsewhere, for example, on Wikidata or
+#'   CIDOC-CRM. Defaults to \code{NA_character_}; if left missing, no
+#'   equivalence relations is will be claimed.
+#' @param equivalence_id The identifier that uniquely identifies this item among
+#' another system's definitions. Defaults to
+#'   \code{NA_character_}; if left missing, no equivalence relations is will be
+#'   claimed.
 #' @param language Defaults to \code{c("en")}. A character string of
 #'   the languages in which the users wants to receive the labels and
 #'   descriptions of the property. The vector of languages must use \href{https://en.wikipedia.org/wiki/IETF_language_tag}{BCP

R/create_dual_item.R

@@ -2,8 +2,7 @@
 #' @description
 #' A small dataset of countries, including sovereign states and autonomous
 #' parts of federal states taken from Wikidata.
-#' @format ## `wikidata_countries_df`
-#' A data frame with 4 rows and 4 columns:
+#' @format A data frame with 4 rows and 4 columns:
 #' \describe{
 #'   \item{qid}{QID of the item.}
 #'   \item{label}{Name label of the item.}

R/data-wikidata_countries_df.R

@@ -0,0 +1,2 @@
+#' @rdname wikidata_countries_df
+"wikidata_countries_df"

R/data.R

@@ -144,7 +144,8 @@ get_csrf <- function(username, password, wikibase_api_url) {
 #' @importFrom httr handle GET POST content
 #' @export
 get_csrf_token <- function(csrf) {
-  csrf_data <- httr::content(csrf, as = "parsed", type = "application/json")
+  csrf_data <- httr::content(csrf, as = "parsed",
+                             type = "application/json")
   csrf_data
   csrf_token <- csrf_data$query$tokens$csrftoken
   if (nchar(csrf_token) < 10) stop("Error: get_csrf_token(csrf): Did not receive a valid token.")