Skip to contents

In your oa_fetch calls, you can specify additional arguments to filter your search result. Available arguments/filters for each entity and associated example values are in the tables below.

Note: x_concepts.id in all entities are experimental.

See the original documentation from Open Alex.

Available arguments by entity

Works

Filter Example value
publication_year 2018
publication_date "2018-02-13"
primary_location.source.issn "2167-8359"
primary_location.license "cc-by"
primary_location.source.host_organization "https://openalex.org/P4310320104"
primary_location.source.type "journal"
type "journal-article"
is_paratext TRUE
open_access.oa_status "gold"
open_access.is_oa TRUE
authorships.author.id "A1969205032"
authorships.author.orcid "0000-0003-1613-5981"
authorships.institutions.id "I4200000001"
authorships.institutions.ror "02nr0ka47"
authorships.institutions.country_code "US"
authorships.institutions.type "nonprofit"
cited_by_count 382
is_retracted FALSE
concepts.id "C2778793908"
concepts.wikidata "https://www.wikidata.org/wiki/Q5122404"
doi "10.7717/peerj.4375"
ids.mag 2741809807
ids.pmid "https://pubmed.ncbi.nlm.nih.gov/23638343/"
ids.pmcid "https://www.ncbi.nlm.nih.gov/pmc/articles/PMC3628373/"**
alternate_host_venues.license "cc-by"
alternate_host_venues.version "submittedVersion"
alternate_host_venues.venue_id "V1983995261"
display_name.search "wombat"
abstract.search "artificial intelligence"
fulltext.search "climate change"
raw_affiliation_string.search "department of political science university of Amsterdam"
has_abstract TRUE
has_doi FALSE
has_ngrams TRUE
has_references TRUE
cites "W2741809807"
cited_by "W2766808518"
related_to "W2486144666"
from_publication_date "2022-08-01"
to_publication_date "2022-08-11"
has_oa_accepted_or_published_version TRUE
has_oa_submitted_version TRUE

Authors

Filter Example value
works_count ">99"
cited_by_count ">1000"
last_known_institution.id "I4200000001"
last_known_institution.ror "02nr0ka47"
last_known_institution.country_code "CA"
last_known_institution.type "nonprofit"
openalex "A2208157607"
orcid "0000-0001-6187-6610"
mag "2208157607"
twitter "jasonpriem"
wikipedia "https://en.wikipedia.org/wiki/Jennifer_Doudna"
scopus "http://www.scopus.com/inward/authorDetails.url?authorID=36455008000&partnerID=MN8TOARS"
x_concepts.id "C41008148"
display_name.search "tupolev"
search "Phillip Kuo"
has_orcid TRUE

Venues

Filter Example value
issn "2167-8359"
publisher "Peerj"
works_count 20184
cited_by_count 133702
x_concepts.id "C185592680"
is_oa TRUE
is_in_doaj TRUE
openalex "V1983995261"
issn_l "2167-8359"
issn "2167-8359"
mag 1983995261
display_name.search "Neurology"
has_issn FALSE

Institutions

Filter Example value
country_code "CN"
type "education"
works_count "<999"
cited_by_count ">20000"
x_concepts.id "C41008148"
display_name.search "technology"
has_ror FALSE
openalex "C41008148"
ror "0130frc33"
mag "114027177"
grid "grid.10698.36"
wikipedia "https://en.wikipedia.org/wiki/University%20of%20North%20Carolina%20at%20Chapel%20Hill"
wikidata "https://www.wikidata.org/wiki/Q192334"

Concepts

Filter Example value
level 3
works_count "<999"
cited_by_count ">10000"
ancestors.id "C161191863"
openalex "C2522767166"
wikidata_id "Q14565201"
mag "2778407487114027177"
wikipedia "https://en.wikipedia.org/wiki/Altmetrics"
umls_aui
umls_cui
display_name.search "electrodynamics"
has_wikidata FALSE

Examples

library(openalexR)
#> Thank you for using openalexR!
#> To acknowledge our work, please cite the package by calling `citation("openalexR")`.
#> To suppress this message, add `openalexR.message = suppressed` to your .Renviron file.

# Unlike the other filters, search does NOT require an exact match. 
# This is particularly useful to search for authors. Some authors have their middle names in a variety of forms, which may not exist, or co-exist in OpenAlex (e.g. Phillip H. Kuo, Phillip Hsin Kuo).  
# The display_name search returns an exact match, and will NOT find all these variations. For example, author "Phillip H. Kuo" and "Phillip Hsin Kuo" is the same person.
# His middle name are recorded differently in openAlex. Therefore, all the varitions can only be found either using search ="Phillip Kuo" or display_name =c("Phillip H. Kuo" , "Phillip Hsin Kuo").

authors_from_names <- oa_fetch(
  entity = "authors", 
  search = "Phillip Kuo"
 )


lib_concepts <- oa_fetch(
  entity = "concepts", 
  level = 3,
  works_count = "<999",
  cited_by_count = ">10000",
  ancestors.id = "C161191863",
  has_wikidata = TRUE
)
dplyr::glimpse(lib_concepts)
#> Rows: 1
#> Columns: 16
#> $ id                         <chr> "https://openalex.org/C2777765086"
#> $ display_name               <chr> "Co-citation"
#> $ display_name_international <list> <"kocitace", "Kozitation", "co-citation", "…
#> $ description                <lgl> NA
#> $ description_international  <list> "situace, kdy dva různé dokumenty jsou cito…
#> $ wikidata                   <chr> "https://www.wikidata.org/wiki/Q1785764"
#> $ level                      <int> 3
#> $ ids                        <list> <"https://openalex.org/C2777765086", "http…
#> $ image_url                  <lgl> NA
#> $ image_thumbnail_url        <lgl> NA
#> $ ancestors                  <list> [<data.frame[6 x 4]>]
#> $ related_concepts           <list> [<data.frame[5 x 5]>]
#> $ works_count                <int> 781
#> $ cited_by_count             <int> 28786
#> $ counts_by_year             <list> [<data.frame[13 x 3]>]
#> $ works_api_url              <chr> "https://api.openalex.org/works?filter=conc…

tech_insts <- oa_fetch(
  entity = "institutions", 
  country_code = "CN",
  x_concepts.id = "C41008148",
  display_name.search = "technology",
  has_ror = FALSE
)
dplyr::glimpse(tech_insts)
#> Rows: 404
#> Columns: 22
#> $ id                         <chr> "https://openalex.org/I204983213", "https:/…
#> $ display_name               <chr> "Harbin Institute of Technology", "Huazhong…
#> $ display_name_alternatives  <list> "哈尔滨工业大学", <"华中科技大学", "Huázhō…
#> $ display_name_acronyms      <list> "HIT", "HUST", "USTC", "DUT", "SCUT", "BIT…
#> $ display_name_international <list> <"Harbin Texnologiya İnstitutu", "Institut…
#> $ ror                        <chr> "https://ror.org/01yqg2h08", "https://ror.o…
#> $ ids                        <list> <"https://openalex.org/I204983213", "https…
#> $ country_code               <chr> "CN", "CN", "CN", "CN", "CN", "CN", "CN", "…
#> $ geo                        <list> [<data.frame[1 x 7]>], [<data.frame[1 x 7]…
#> $ type                       <chr> "education", "education", "education", "edu…
#> $ homepage_url               <chr> "http://en.hit.edu.cn/", "http://english.hu…
#> $ image_url                  <chr> "https://commons.wikimedia.org/w/index.php?…
#> $ image_thumbnail_url        <chr> "https://commons.wikimedia.org/w/index.php?…
#> $ associated_institutions    <list> NA, [<data.frame[3 x 6]>], [<data.frame[6 …
#> $ relevance_score            <dbl> 16392.518, 15676.650, 14645.319, 13821.585,…
#> $ works_count                <int> 165094, 190343, 141993, 101112, 111798, 975…
#> $ cited_by_count             <int> 2343403, 3097224, 3176585, 1665581, 1941138…
#> $ counts_by_year             <list> [<data.frame[13 x 3]>], [<data.frame[13 x …
#> $ works_api_url              <chr> "https://api.openalex.org/works?filter=inst…
#> $ x_concepts                 <list> [<data.frame[20 x 5]>], [<data.frame[19 x …
#> $ updated_date               <chr> "2024-02-15T09:21:38.660289", "2024-02-15T0…
#> $ created_date               <chr> "2016-06-24", "2016-06-24", "2016-06-24", "…

peer_venues <- oa_fetch(
  entity = "sources", 
  display_name = "PeerJ",
  x_concepts.id = "C185592680",
  is_oa = TRUE,
  is_in_doaj = TRUE
)
dplyr::glimpse(peer_venues)
#> Rows: 1
#> Columns: 26
#> $ id                        <chr> "https://openalex.org/S1983995261"
#> $ issn_l                    <chr> "2167-8359"
#> $ issn                      <list> "2167-8359"
#> $ display_name              <chr> "PeerJ"
#> $ host_organization         <chr> "https://openalex.org/P4310320104"
#> $ host_organization_name    <chr> "PeerJ, Inc."
#> $ host_organization_lineage <list> "https://openalex.org/P4310320104"
#> $ works_count               <int> 15123
#> $ cited_by_count            <int> 228879
#> $ summary_stats             <list> <1.676587, 117.000000, 6262.000000>
#> $ is_oa                     <lgl> TRUE
#> $ is_in_doaj                <lgl> TRUE
#> $ ids                       <list> <"https://openalex.org/S1983995261", "2167-8…
#> $ homepage_url              <chr> "http://www.peerj.com/"
#> $ apc_prices                <list> [1395, "USD"]
#> $ apc_usd                   <int> 1395
#> $ country_code              <chr> "US"
#> $ societies                 <lgl> NA
#> $ alternate_titles          <list> <"Peer j", "Peerj">
#> $ abbreviated_title         <chr> "PeerJ"
#> $ type                      <chr> "journal"
#> $ x_concepts                <list> [<data.frame[23 x 5]>]
#> $ counts_by_year            <list> [<data.frame[13 x 3]>]
#> $ works_api_url             <chr> "https://api.openalex.org/works?filter=prima…
#> $ updated_date              <chr> "2024-02-15T08:44:07.485621"
#> $ created_date              <chr> "2016-06-24"