sn_get_details_by_country: Get a pre-defined set of details about

View source: R/sn_get_details.R

sn_get_details_by_countryR Documentation

Get a pre-defined set of details about

Description

Get a pre-defined set of details about

Usage

sn_get_details_by_country(
  country,
  additional_properties = c("P39", "P509", "P140", "P611", "P411", "P241", "P410", "P97",
    "P607", "P27", "P172"),
  lau_year = 2020,
  export_format = NULL,
  collapse_lists = FALSE,
  language = tidywikidatar::tw_get_language(),
  search_language = NULL,
  response_language = tidywikidatar::tw_get_language(),
  check_named_after_original = TRUE,
  check_named_after_original_n = 1,
  check_named_after = TRUE,
  checked_df = NULL,
  manual_check_columns = FALSE,
  connection = NULL,
  connection_search = NULL,
  base_folder = "sn_data",
  streets_sf = NULL,
  cache = TRUE,
  overwrite_cache = FALSE,
  disconnect_db = TRUE
)

Arguments

country

A country, either a two letter country code, or country full name. See 'sn_country_codes' for valid values.

additional_properties

Defaults to a vector of Wikidata properties, with common properties of interest for humans. Some basic properties related to birth, death, and occupation are included by default.

export_format

Defaults to NULL. If given, it exports outputs in the given format. Available values include "csv" and "geojson".

collapse_lists

Defaults to FALSE. If TRUE, collapses multiple values in a single string, with each value separated by ";". Useful for exports in tabular format.

search_language

Defaults to NULL, guessed based on country.

response_language

Defaults to 'tidywikidatar::tw_get_language()'. Used for defining the language in which label and description are returned.

check_named_after_original

Defaults to FALSE. If TRUE, a search is performed on the original street name. If the first result has values for the property "named after", this takes precedence over other methods.

check_named_after

Defaults to FALSE. If TRUE, a search is performed on the "cleaned" name of the street. If the result is a street, road, square, or similar, and this has values for the property "named after", this is kept instead of the standard method.

checked_df

Defaults to NULL. If given, a data frame with a 'street_name' and 'named_after_id' column. Takes precedence over searches.

manual_check_columns

Logical, defaults to FALSE. If set to TRUE, it adds additional columns that can be used to introduce manually adjustments in a spreadsheet.

streets_sf

Defaults to NULL. If given, used to speed up processing. Must be an sf object such as the ones output by 'll_osm_get_roads()'. Passed to 'll_osm_get_lau_streets()'.

cache

Logical, defaults to TRUE.

disconnect_db

Defaults to TRUE. If FALSE, leaves the connection to cache open.


giocomai/streetnamer documentation built on Oct. 14, 2023, 6:27 p.m.