newsanchor (version 0.1.1)

get_headlines: Returns selected headlines from newsapi.org

Description

get_headlines returns live top and breaking headlines for a country, specific category in a country, single source, or multiple sources. You can also search with keywords. Articles are sorted by the earliest date published first. To automatically download all results, use get_headlines_all(). Please check that the api_key is available. You can provide an explicit definition of the key or use set_api_key(). Valid searchterms are provided in the data sets terms_category, terms_country or terms_sources.

Usage

get_headlines(query = NULL, category = NULL, country = NULL,
  sources = NULL, page = 1, page_size = 100,
  api_key = Sys.getenv("NEWS_API_KEY"))

Arguments

query

Character string that contains the searchterm.

category

Character string with the category you want headlines from.

country

Character string with the country you want headlines from.

sources

Character vector with with IDs of the news outlets you want to focus on (e.g., c("usa-today", "spiegel-online")).

page

Specifies the page number of your results that is returned. Must be numeric. Default is first page. If you want to get all results at once, use get_headlines_all from 'newsanchor'.

page_size

The number of articles per page that are returned. Maximum is 100 (also default).

api_key

Character string with the API key you get from newsapi.org. Passing it is compulsory. Alternatively, a function can be provided from the global environment (see set_api_key).

Value

List with two dataframes: 1) Data frame with results_df 2) Data frame with meta_data

Examples

# NOT RUN {
df <- get_headlines(sources = "bbc-news")
df <- get_headlines(query = "sports", page = 2)
df <- get_headlines(category = "business")
# }