seTag-class: Class '"seTag"': A class to represent a StackExchange tag

In geoffjentry/RStackExchange: R based StackExchange client

Description

Provides a model representing a tag from a StackExchange site

Details

The seTag 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 seTagFactory. 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

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, num=NULL):

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. If num is specified, will return at most num results.

topAnswerers(period, num=NULL):

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

getTags, getTagSynonyms, setRefClass

Examples

   tags <- getTags(num=5)
   tags[[2]]$topAskers('all-time')

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