Collect.search.mastodon: Collect post data from mastodon search

View source: R/Collect.search.mastodon.R

Collect.search.mastodonR Documentation

Collect post data from mastodon search

Description

This function collects posts based on search terms and structures the data into a dataframe with the class names "datasource" and "mastodon".

Usage

## S3 method for class 'search.mastodon'
Collect(
  credential,
  endpoint,
  hashtag = NULL,
  instance = NULL,
  local = FALSE,
  numPosts = 100,
  anonymous = TRUE,
  retryOnRateLimit = TRUE,
  writeToFile = FALSE,
  verbose = FALSE,
  ...
)

Arguments

credential

A credential object generated from Authenticate with class name "mastodon".

endpoint

API endpoint.

hashtag

Character string. Specifies a mastodon query to search on e.g #hashtag. Set to NULL for unfiltered public posts. Default is NULL.

instance

Character string. Server to collect posts from. Default is NULL.

local

Logical. Search the local server or global timeline. FALSE.

numPosts

Numeric. Specifies how many tweets to be collected. Default is 100.

anonymous

Logical. Collect public posts without authenticating. Default is TRUE.

retryOnRateLimit

Logical. When the API rate-limit is reached should the collection wait and resume when it resets. Default is TRUE.

writeToFile

Logical. Write collected data to file. Default is FALSE.

verbose

Logical. Output additional information. Default is FALSE.

...

Arguments passed on to rtoot::get_timeline_hashtag

only_media

logical, Show only statuses with media attached?

min_id

character, Return results immediately newer than this id

Value

A tibble object with class names "datasource" and "mastodon".


vosonlab/vosonSML documentation built on April 28, 2024, 6:26 a.m.