Controlled vocabulary for affiliation match signals

The ordered set of values the match_signal column of sm_affiliation_match() / sm_affiliation_summary() can take. Using this helper (rather than hard-coding strings) means downstream filtering — e.g. separating institution-name matches from email-domain matches — cannot drift if the levels change.

Usage

sm_affiliation_signals(describe = FALSE)

Arguments

describe

Logical; if TRUE, return a tibble of level + a short description. If FALSE (default), return the ordered character vector of levels (suitable for factor(levels = )).

Value

A character vector (ordered, highest matching priority first) or a tibble of level/description.

See also

sm_affiliation_match(), sm_affiliation_methods()

Other affiliation: sm_affiliation_match(), sm_affiliation_methods(), sm_affiliation_summary(), sm_attribute_institution()

Examples

sm_affiliation_signals()
#> [1] "name_token"   "email_domain" "postcode"     "none"        
sm_affiliation_signals(describe = TRUE)
#> # A tibble: 4 × 2
#>   level        description                                                 
#>   <fct>        <chr>                                                       
#> 1 name_token   Institution name token matched a dictionary pattern.        
#> 2 email_domain Author email domain matched a dictionary email domain.      
#> 3 postcode     Affiliation postcode matched a dictionary postcode (opt-in).
#> 4 none         No signal matched this authorship.