tidying up via styler

Author: mustberuss

R/cast-pv-data.R

@@ -6,8 +6,7 @@ get_cast_fun <- function(data_type) {
   # Some fields aren't documented, so we don't know what their data type is. Use
   # string type for these.
   if (length(data_type) != 1) data_type <- "string"
-  switch(
-    data_type,
+  switch(data_type,
     "string" = as_is,
     "date" = as.Date,
     "float" = as.numeric,
@@ -97,7 +96,7 @@ cast_one <- function(one, name, typesdf) UseMethod("cast_one")
 cast_pv_data <- function(data) {
   validate_pv_data(data)
 
-  entity_name <- names(data)  # preserve insanity, singular/plural/nonsensical name
+  entity_name <- names(data) # preserve insanity, singular/plural/nonsensical name
   endpoint <- endpoint_from_entity(entity_name)
 
   typesdf <- fieldsdf[fieldsdf$endpoint == endpoint, c("common_name", "data_type")]
@@ -110,7 +109,7 @@ cast_pv_data <- function(data) {
 
   df[] <- list_out
   out_data <- list(x = df)
-  names(out_data) <- entity_name  # preserve entity's name
+  names(out_data) <- entity_name # preserve entity's name
 
   structure(
     out_data,

R/check-query.R

@@ -5,34 +5,39 @@ swap_null_nms <- function(obj) {
 }
 
 #' @noRd
-is_int <- function(x)
-  if (is.numeric(x)) abs(x - round(x)) < .Machine$double.eps^ 0.5 else FALSE
+is_int <- function(x) {
+  if (is.numeric(x)) abs(x - round(x)) < .Machine$double.eps^0.5 else FALSE
+}
 
 #' @noRd
-is_date <- function(x)
+is_date <- function(x) {
   grepl("[12][[:digit:]]{3}-[01][[:digit:]]-[0-3][[:digit:]]", x)
+}
 
 #' @noRd
 one_check <- function(operator, field, value, f1) {
-
-  if (nrow(f1) == 0)
+  if (nrow(f1) == 0) {
     stop2(field, " is not a valid field to query for your endpoint")
-  if (f1$data_type == "date" && !is_date(value))
+  }
+  if (f1$data_type == "date" && !is_date(value)) {
     stop2("Bad date: ", value, ". Date must be in the format of yyyy-mm-dd")
-  if (f1$data_type %in% c("string", "fulltext") && !is.character(value))
+  }
+  if (f1$data_type %in% c("string", "fulltext") && !is.character(value)) {
     stop2(value, " must be of type character")
-  if (f1$data_type == "integer" && !is_int(value))
+  }
+  if (f1$data_type == "integer" && !is_int(value)) {
     stop2(value, " must be an integer")
+  }
 
   if (
     # The new version of the API blurrs the distinction between string/fulltext fields.
     # It looks like the string/fulltext functions can be used interchangeably
-    (operator %in% c("_begins", "_contains", "_text_all", "_text_any", "_text_phrase") && 
+    (operator %in% c("_begins", "_contains", "_text_all", "_text_any", "_text_phrase") &&
       !(f1$data_type == "fulltext" || f1$data_type == "string")) ||
-    (f1$data_type %in% c("string", "fulltext") &&
-      operator %in% c("_gt", "_gte", "_lt", "_lte"))
-  )
+      (f1$data_type %in% c("string", "fulltext") &&
+        operator %in% c("_gt", "_gte", "_lt", "_lte"))  ) {
     stop2("You cannot use the operator ", operator, " with the field ", field)
+  }
 }
 
 #' @noRd

R/data.R

@@ -15,4 +15,4 @@
 #'   \item{group}{The group the field belongs to}
 #'   \item{common_name}{The field name without the parent group structure}
 #' }
-"fieldsdf"
+"fieldsdf"

R/get-fields.R

@@ -61,7 +61,6 @@ get_fields <- function(endpoint, groups = NULL) {
 #' @return A character vector with the names of each endpoint.
 #' @export
 get_endpoints <- function() {
-
   # now the endpoints are singular
   # note that now there are two rel_app_texts, one under patents and one under publications
   c(

R/print.R

@@ -24,14 +24,16 @@ print.pv_data_result <- function(x, ...) {
   )
 
   utils::str(
-    x, vec.len = 1, max.level = 2, give.attr = FALSE, strict.width = "cut"
+    x,
+    vec.len = 1, max.level = 2, give.attr = FALSE, strict.width = "cut"
   )
 }
 
 #' @export
 print.pv_relay_db <- function(x, ...) {
   utils::str(
-    x, vec.len = 1, max.level = 2, give.attr = FALSE, strict.width = "cut"
+    x,
+    vec.len = 1, max.level = 2, give.attr = FALSE, strict.width = "cut"
   )
 }
 

R/query-dsl.R

@@ -133,7 +133,7 @@ create_between_fun <- function(fun) {
 #'
 #' There is 1 convenience function:
 #' \itemize{
-#'    \item \code{in_range} - Builds a <= x <= b query 
+#'    \item \code{in_range} - Builds a <= x <= b query
 #'  }
 #'
 #' @return An object of class \code{pv_query}. This is basically just a simple
@@ -144,9 +144,9 @@ create_between_fun <- function(fun) {
 #'
 #' qry_funs$not(qry_funs$eq(patent_date = "2001-01-01"))
 #'
-#' qry_funs$in_range(patent_year=c(2010, 2021))
+#' qry_funs$in_range(patent_year = c(2010, 2021))
 #'
-#' qry_funs$in_range(patent_date=c("1970-01-01","1983-02-28"))
+#' qry_funs$in_range(patent_date = c("1970-01-01", "1983-02-28"))
 
 #' @export
 qry_funs <- c(
@@ -185,16 +185,16 @@ qry_funs <- c(
 #'   )
 #' )
 #'
-#' #...With it, this becomes:
+#' # ...With it, this becomes:
 #' with_qfuns(
-#'  and(
-#'    gte(patent_date = "2007-01-01"),
-#'    text_phrase(patent_abstract = c("computer program")),
-#'    or(
-#'      eq(inventors.inventor_name_last = "Ihaka"),
-#'      eq(inventors.inventor_name_last = "Chris")
-#'    )
-#'  )
+#'   and(
+#'     gte(patent_date = "2007-01-01"),
+#'     text_phrase(patent_abstract = c("computer program")),
+#'     or(
+#'       eq(inventors.inventor_name_last = "Ihaka"),
+#'       eq(inventors.inventor_name_last = "Chris")
+#'     )
+#'   )
 #' )
 #'
 #' @export

R/search-pv.R

@@ -84,7 +84,6 @@ one_request <- function(method, query, base_url, arg_list, api_key, ...) {
 
     one_request(method, query, base_url, arg_list, api_key, ...)
   } else {
-
     if (httr::http_error(resp)) throw_er(resp)
 
     resp
@@ -248,7 +247,6 @@ search_pv <- function(query,
                       error_browser = NULL,
                       api_key = Sys.getenv("PATENTSVIEW_API_KEY"),
                       ...) {
-
   validate_args(api_key, fields, endpoint, method, page, per_page, sort)
   deprecate_warn_all(error_browser, subent_cnts, mtchd_subent_only)
 
@@ -269,7 +267,9 @@ search_pv <- function(query,
 
   result <- one_request(method, query, base_url, arg_list, api_key, ...)
   result <- process_resp(result)
-  if (!all_pages) return(result)
+  if (!all_pages) {
+    return(result)
+  }
 
   # Here we ignore the user's sort and instead have the API sort by the primary
   # key for the requested endpoint.  This simplifies the paging's after parameter.
@@ -291,15 +291,15 @@ search_pv <- function(query,
   # The API throws an error if the sort field is not present in the fields list
   # **Should we remember if we added the primary_sort_key and remove it before
   # returning data to the user?
-  primary_sort_key <-  get_default_sort(endpoint)
+  primary_sort_key <- get_default_sort(endpoint)
 
   if (!names(primary_sort_key) %in% fields) fields <- c(fields, names(primary_sort_key))
 
   arg_list <- to_arglist(fields, page, per_page, primary_sort_key)
   full_data <- request_apply(result, method, query, base_url, arg_list, api_key, ...)
 
   # apply the user's sort
-  data.table::setorderv(full_data, names(sort), ifelse(as.vector(sort)=="asc", 1, -1))
+  data.table::setorderv(full_data, names(sort), ifelse(as.vector(sort) == "asc", 1, -1))
   result$data[[1]] <- full_data
 
   result
@@ -321,41 +321,41 @@ search_pv <- function(query,
 #'
 #' retrieve_linked_data(
 #'   "https://search.patentsview.org/api/v1/cpc_group/G01S7:4811/"
-#'  )
+#' )
 #'
 #' retrieve_linked_data(
 #'   'https://search.patentsview.org/api/v1/patent/?q={"_text_any":{"patent_title":"COBOL cotton gin"}}&s=[{"patent_id": "asc" }]&o={"size":50}&f=["inventors.inventor_name_last","patent_id","patent_date","patent_title"]'
-#'  )
+#' )
 #' }
 #'
 #' @export
 retrieve_linked_data <- function(url,
                                  api_key = Sys.getenv("PATENTSVIEW_API_KEY"),
-                                 ...
-                                ) {
-
+                                 ...) {
   # There wouldn't be url parameters on a HATEOAS link but we'll also accept
   # example urls from the documentation, where there could be parameters
   url_peices <- httr::parse_url(url)
   params <- list()
-  query <- ''
+  query <- ""
 
-  if(!is.null(url_peices$query))
-  {
-     url = paste0(url_peices$scheme,'://',url_peices$hostname, '/', url_peices$path)
+  if (!is.null(url_peices$query)) {
+    url <- paste0(url_peices$scheme, "://", url_peices$hostname, "/", url_peices$path)
 
-     # need to change f to fields, s to sort and o to opts 
-     # probably a whizbangy better way to do this in R
-     if(!is.null(url_peices$query$f))
-        params$fields = jsonlite::fromJSON(url_peices$query$f)
+    # need to change f to fields, s to sort and o to opts
+    # probably a whizbangy better way to do this in R
+    if (!is.null(url_peices$query$f)) {
+      params$fields <- jsonlite::fromJSON(url_peices$query$f)
+    }
 
-     if(!is.null(url_peices$query$s))
-        params$sort = jsonlite::fromJSON(url_peices$query$s)
+    if (!is.null(url_peices$query$s)) {
+      params$sort <- jsonlite::fromJSON(url_peices$query$s)
+    }
 
-     if(!is.null(url_peices$query$o))
-        params$opts = jsonlite::fromJSON(url_peices$query$o)
+    if (!is.null(url_peices$query$o)) {
+      params$opts <- jsonlite::fromJSON(url_peices$query$o)
+    }
 
-     query <- if(!is.null(url_peices$query$q)) url_peices$query$q else ''
+    query <- if (!is.null(url_peices$query$q)) url_peices$query$q else ""
   }
 
   # Only send the API key to subdomains of patentsview.org

R/unnest-pv-data.R

@@ -18,32 +18,30 @@
 #'
 #' @export
 get_ok_pk <- function(endpoint) {
+  # most of the nested endpoints use patent_id, except patent/attorney uses "attorney_id"
+  # publications (unnested) uses document_number
+  use_document_number <- c(
+    # if endpoint is passed
+    "publication", "publication/rel_app_text",
 
-# most of the nested endpoints use patent_id, except patent/attorney uses "attorney_id"
-# publications (unnested) uses document_number
-use_document_number <- c(
-  # if endpoint is passed
-  "publication", "publication/rel_app_text",
-
-  # if names(pv_out[["data"]]) passed
-  "publications", "rel_app_text_publications"
-)
+    # if names(pv_out[["data"]]) passed
+    "publications", "rel_app_text_publications"
+  )
 
-use_patent_id <- c(
-  # if endpoint passed
-  "patent/us_application_citation", "patent/us_patent_citation",
-  "patent/rel_app_text", "patent/foreign_citation", "patent/rel_app_text",
-  "publication/rel_app_text",
+  use_patent_id <- c(
+    # if endpoint passed
+    "patent/us_application_citation", "patent/us_patent_citation",
+    "patent/rel_app_text", "patent/foreign_citation", "patent/rel_app_text",
+    "publication/rel_app_text",
 
-  # if names(pv_out[["data"]]) passed
-  "us_application_citations", "us_patent_citations", "foreign_citations",
-  "rel_app_texts", "patents","brf_sum_texts","detail_desc_texts", 
-  "draw_desc_texts"
-)
+    # if names(pv_out[["data"]]) passed
+    "us_application_citations", "us_patent_citations", "foreign_citations",
+    "rel_app_texts", "patents", "brf_sum_texts", "detail_desc_texts",
+    "draw_desc_texts"
+  )
   if (endpoint %in% use_document_number) {
     "document_number"
-  }
-  else if (endpoint %in% use_patent_id ) {
+  } else if (endpoint %in% use_patent_id) {
     "patent_id"
   } else {
     key <- to_singular(endpoint)
@@ -86,7 +84,6 @@ use_patent_id <- c(
 #'
 #' @export
 unnest_pv_data <- function(data, pk = get_ok_pk(names(data))) {
-
   validate_pv_data(data)
 
   df <- data[[1]]

R/utils.R

@@ -54,8 +54,8 @@ to_singular <- function(plural) {
   # wipo endpoint returns singluar wipo as the entity
   # attorneys accidently works
 
-  if(plural == "wipo") {
-     singular = plural
+  if (plural == "wipo") {
+    singular <- plural
   } else if (endsWith(plural, "ies")) {
     singular <- sub("ies$", "y", plural)
   } else if (endsWith(plural, "es") && !endsWith(plural, "ees")) {
@@ -75,11 +75,10 @@ to_plural <- function(singular) {
   singular <- sub("^patent/", "", singular)
   singular <- sub("^publication/", "", singular)
 
-  if(singular  == "wipo") {
-     plural = singular
-  } 
-  else if (singular == "attorney") {
-     plural <- "attorneys"
+  if (singular == "wipo") {
+    plural <- singular
+  } else if (singular == "attorney") {
+    plural <- "attorneys"
   } else if (endsWith(singular, "y")) {
     plural <- sub("y$", "ies", singular)
   } else if (endsWith(singular, "s")) {
@@ -91,22 +90,23 @@ to_plural <- function(singular) {
 
 #' @noRd
 endpoint_from_entity <- function(entity) {
-   # needed for casting to work with singular endpoints and mostly plural entities
-
-   if(entity == "rel_app_text_publications") {
-      "publication/rel_app_texts"
-   } else if (entity == "rel_app_text") {
-      "publication/rel_app_text"
-   } else if (entity == "other_reference") {
-      "patent/otherreference"
-   } else {
-      singular <- to_singular(entity)
-
-      # figure out if the endpoint is nested
-      nested <- c("attorney", "foreign_citation", "us_application_citation",
-                  "us_patent_citation", "rel_app_text")
-
-      if(singular %in% nested) paste0("patent/", singular) else singular
-   }
-}
+  # needed for casting to work with singular endpoints and mostly plural entities
+
+  if (entity == "rel_app_text_publications") {
+    "publication/rel_app_texts"
+  } else if (entity == "rel_app_text") {
+    "publication/rel_app_text"
+  } else if (entity == "other_reference") {
+    "patent/otherreference"
+  } else {
+    singular <- to_singular(entity)
+
+    # figure out if the endpoint is nested
+    nested <- c(
+      "attorney", "foreign_citation", "us_application_citation",
+      "us_patent_citation", "rel_app_text"
+    )
 
+    if (singular %in% nested) paste0("patent/", singular) else singular
+  }
+}