Skip to contents

oa_fetch but for a random query

Source: R/oa_fetch.R
oa_random.Rd

oa_fetch but for a random query

Usage

oa_random(
  entity = oa_entities(),
  output = c("tibble", "dataframe", "list"),
  endpoint = "https://api.openalex.org"
)

Arguments

entity

Character. Scholarly entity of the search. The argument can be one of c("works", "authors", "venues", "institutions", "concepts"). If not provided, `entity` is guessed from `identifier`.

output

Character. Type of output, either a list or a tibble/data.frame.

endpoint

Character. URL of the OpenAlex Endpoint API server. Defaults to endpoint = "https://api.openalex.org".

Value

A data.frame or a list. One row or one element. Result of the random query. If you would like to select more than one random entity, use the `sample` argument in `oa_fetch`.

Examples

oa_random()
#> # A tibble: 1 × 28
#>   id        displ…¹ author ab    publi…² relev…³ so    so_id publi…⁴ issn  url  
#>   <chr>     <chr>   <list> <lgl> <chr>   <lgl>   <chr> <chr> <lgl>   <lis> <lgl>
#> 1 https://… [First… <df>   NA    1957-0… NA      La R… http… NA      <chr> NA   
#> # … with 17 more variables: first_page <chr>, last_page <chr>, volume <chr>,
#> #   issue <chr>, is_oa <lgl>, cited_by_count <int>, counts_by_year <lgl>,
#> #   publication_year <int>, cited_by_api_url <chr>, ids <list>, doi <lgl>,
#> #   type <chr>, referenced_works <lgl>, related_works <list>,
#> #   is_paratext <lgl>, is_retracted <lgl>, concepts <list>, and abbreviated
#> #   variable names ¹​display_name, ²​publication_date, ³​relevance_score,
#> #   ⁴​publisher