seTopTag-class: Class '"seTopTag"': A class to represent a StackExchange top...

In geoffjentry/RStackExchange: R based StackExchange client

Description

Provides a model representing a top tag from a StackExchange site

Details

The seTopTag class is a subclass of the seTag class, and represents a frequently used tag for a specific user.

The seTopTag class is implemented as a reference class. An instance of a generator for this class is provided as a convenience to the user as it is configured to handle most standard cases. To access this generator, use the object seTopTagFactory. Accessor set & get methods are provided for every field using reference class $accessors() methodology (see setRefClass). As an example, the count field could be accessed with object$getCount() and object$setCount().

As noted in the Methods section, both methods take a period argument which must be one of either all-time or month.

Fields

name:

Name of the tag

questionScore:

Cumulative score for this tag for the user

questionCount:

Number of questions this user has posed with this tag

answerScore:

Cumulative score for this tag for this user

answerCount:

Number of answers this user has posted with this tag

count:

Number of times this tag has been used

fulfillsRequired:

Logical, indicates if tag is required to be on a post

site:

Object of class character ~~

Methods

topAskers(period):

Retrieves the seUser objects for the people who have asked the most questions with this tag for a given period, either all-time or month

topAnswerers(period):

Retrieves the seUser objects for the people who have answered the most questions with this tag for a given period, either all-time or month

Author(s)

Jeff Gentry

See Also

seTag, getTags, getTagSynonyms, setRefClass

Examples

    zz <- searchUsers(num=2, filter='geoff')
    zz[[1]]$topTagsByQuestions()

geoffjentry/RStackExchange documentation built on May 17, 2019, 1:11 a.m.