account_update: Updates mentions for accounts

Description Usage Arguments Details Value Methods (by class) Author(s)

Description

The various storage formats are only relevant in terms of what parameters they allow you to set on the mention. Calling account will return an account object of the appropriate type, while the account_api_version method will indicate the type that it is. Most new accounts are stored in the V4 format, and so support the parameters of the V4 generic method below.

Updates mentions for accounts supplied as a vector of character codes.

Updates mentions for accounts in our older format.

Updates mentions for accounts stored in our newer format.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
account_update(account, ...)

## S3 method for class 'character'
account_update(code, filter, tag, sentiment, media,
  auto.confirm = FALSE, authentication = pkg.env$defaultAuthentication, ...)

## S3 method for class 'brandseye.account.v3'
account_update(account, filter, tag, sentiment,
  media, auto.confirm = FALSE, authentication = account$auth)

## S3 method for class 'brandseye.account.v4'
account_update(account, filter, relevancy,
  relevancyVerified, tag, removeTag, sentiment, sentimentVerified, media,
  gender, language, race, addPhrases, removePhrases, addCrowdJobs,
  removeCrowdJobs, updateAuthor, auto.confirm = FALSE,
  authentication = account$auth)

Arguments

account

An account object.

code

A character string for the account to update

filter

A filter selecting mentions to update

tag

Either an id of a tag to update the selected mentions with, or a character string holding a tag name.

sentiment

An integer representing sentiment. A value between -5 and 5. 0 is not a valid number, and 1 represents neutral sentiment.

media

A string indicating the category of the mentions, such as CONSUMER or PRESS

auto.confirm

Some actions, such as setting sentiment, will ask for interactive confirmation of the action. If you're running from a script, this can be inconvenient. You can override that behaviour by setting this parameter to TRUE. Buyer beware.

relevancy

A string indicating whether mentions are relevant or not.

relevancyVerified

A boolean indicating whether to consider the relevancy as verifed or not.

removeTag

A list of tag IDs to remove

sentimentVerified

A boolean indicating whether to consider sentiment as verified or not.

gender

A string indicating the author's gender, such as MALE, FEMALE, OTHER, UNKNOWN.

language

A two letter, lowercase string, giving the iso 639-1 language code for the mention.

race

A string giving the race of the author

addPhrases

A list of integer IDs for phrases to add to the mention

removePhrases

A list of integer IDs for the phrases to remove from the mention

addCrowdJobs

A list of integer IDs representing crowd jobs related to this mention, to be added to the mention.

removeCrowdJobs

A list of integer IDs representing crowd jobs to be removed from this mention.

updateAuthor

Whether the stored author information related to this mention should be updated with any of the information related to the author on this mention, such as race, gender, language or media.

account

The account object.

Details

This function is solely for testing purposes, and its behaviour may change in future versions.

This function is solely for testing purposes, and its behaviour may change in future versions.

Value

Nothing useful yet. This method is a placeholder for testing, and its return values will likely change. Its interface will probably remain stable, although extra arguments may be added.

Methods (by class)

Author(s)

Constance Neeser

Lara Basson


brandseye/brandseyer documentation built on May 13, 2019, 2:30 a.m.