book-class: Class for representing results entities from NYTimes API

In omegahat/RNYTimes: Access to the New York Times REST services

Class for representing results entities from NYTimes API

Description

These classes allow us to turn XML content into structured, formal R objects to describe entities or concepts such as a book, a collection of reviews, an individual review and so on. The primary purpose is to provide structure from the XML content.

Objects from the Class

Objects can be created by calls of the form new("book", ...). Instances, however, are typically created when the XML content returned from an NY Times API request is processed within the functions.

Slots

rank:

Object of class "integer" the ranking of the book on the best seller list

list_name:

Object of class "character" the name of the best seller list, i.e. the type of book

bestsellers_date:

Object of class "Date" the date of the entry on the best seller list.

published_date:

Object of class "Date" the date the book was published

weeks_on_list:

Object of class "integer" the number of weeks on the best seller list.

rank_last_week:

Object of class "integer" the rank on the list the week prior to this entry, allowing us to see if it going up or down the rankings or recently enetered.

asterisk:

Object of class "logical" ?

dagger:

Object of class "logical" ?

book_details:

Object of class "book_details" details about the book

isbns:

Object of class "character" the ISBN string for the book, or potentially several of such strings

reviews:

Object of class "reviews"

Methods

No methods defined with class "book" in the signature.

Author(s)

Duncan Temple Lang

References

See the NY Times API documentation

omegahat/RNYTimes documentation built on Nov. 29, 2023, 12:39 a.m.