address: Address based widgets

In tarakc02/discoveryengine: A CADS Prospecting Tool

Address based widgets

Description

By default the "lives in" widgets use an address type code of "H" (Home) and the "works in" widgets use "B" (Business). Use the type argument to change included address types.

Usage

lives_in_county(
  ...,
  include_alternate = FALSE,
  include_past = FALSE,
  include_seasonal = FALSE,
  include_student_local = FALSE,
  include_student_permanent = FALSE,
  type = "home"
)

lives_in_foreign_country(
  ...,
  include_alternate = FALSE,
  include_past = FALSE,
  include_seasonal = FALSE,
  include_student_local = FALSE,
  include_student_permanent = FALSE,
  city = NULL,
  type = "home"
)

lives_in_msa(
  ...,
  include_alternate = FALSE,
  include_past = FALSE,
  include_seasonal = FALSE,
  include_student_local = FALSE,
  include_student_permanent = FALSE,
  type = "home"
)

lives_in_state(
  ...,
  include_alternate = FALSE,
  include_past = FALSE,
  include_seasonal = FALSE,
  include_student_local = FALSE,
  include_student_permanent = FALSE,
  type = "home"
)

lives_in_zip(
  ...,
  include_alternate = FALSE,
  include_past = FALSE,
  include_seasonal = FALSE,
  include_student_local = FALSE,
  include_student_permanent = FALSE,
  type = "home"
)

works_in_county(
  ...,
  include_alternate = FALSE,
  include_past = FALSE,
  include_self_employed = TRUE,
  type = "business"
)

works_in_foreign_country(
  ...,
  include_alternate = FALSE,
  include_past = FALSE,
  include_self_employed = TRUE,
  city = NULL,
  type = "business"
)

works_in_msa(
  ...,
  include_alternate = FALSE,
  include_past = FALSE,
  include_self_employed = TRUE,
  type = "business"
)

works_in_state(
  ...,
  include_alternate = FALSE,
  include_past = FALSE,
  include_self_employed = TRUE,
  type = "business"
)

works_in_zip(
  ...,
  include_alternate = FALSE,
  include_past = FALSE,
  include_self_employed = TRUE,
  type = "business"
)

Arguments

...	the counties/msas/zips
include_alternate	include addresses coded as "alternate?" Defaults to FALSE
include_past	include past/former addresses? Defaults to FALSE
include_seasonal	for lives_in_*: include seasonal addresses? Defaults to FALSE
include_student_local	for lives_in_*: include student local address? Defaults to FALSE
include_student_permanent	for lives_in_*: include student permanent address? Defaults to FALSE
type	Will be either "home" or "business". Advanced users can specify individual address type codes (see examples)
city	For foreign addresses, a search string to find individual cities (see details and examples)
include_self_employed	for works_in_*: include self-employed business addresses? Defaults to TRUE

Details

Foreign addresses do not have associated county or MSA codes, and currently (as of March 2018) are not geocoded in CADS, so will not be found to the lives_near and works_near widgets. There are no strict code tables associated with cities, but the city argument in the foreign country widgets allow you to search for a particular city by name (see examples)

Value

A definition of type entity_id

Examples

## find anyone who lives or works in the san francisco MSA
lives_in_msa(san_francisco) %or% works_in_msa(san_francisco)

## don't forget about synonym search if you're not sure about a code
lives_in_county(?alameda)

## find people who live in any of these counties
lives_in_county(alameda_ca, san_mateo_ca)

## the best way to find people working in Seoul
works_in_foreign_country(KORER, city = "Seoul")

## people who live abroad or used to live abroad:
lives_in_foreign_country(include_past = TRUE)

## you shouldn't need to, but if necessary
## you can directly specify address type codes:
## make sure you know what you're doing!
lives_in_msa(san_francisco, type = "S")

tarakc02/discoveryengine documentation built on Sept. 26, 2023, 12:17 a.m.