search: Search documents

Description Usage Arguments Details Value Author(s) References Examples

Description

Search and browse Scribd documents

Usage

1
2
3
4
5
6
7
8
docs_search(query, category = NULL, language = NULL,
            simple = TRUE, limit = 10, offset = 0, ...)

docs_featured(scope = "hot", limit = 20, offset = 0, ...)

docs_browse(sort = "popular", limit = 20, offset = 0, ...)

docs_list(limit = 20, offset = 0, ...)

Arguments

query

A character string containing a search query. If simple=TRUE

category

Optionally, a numeric value indicating a Scribd document category, perhaps returned by docs_categories.

language

Optionally, an ISO 639-1 formatted language identifier.

simple

A logical indicating when TRUE (the default), to allow advanced search queries like title:"A Tale of Two Cities". When FALSE, query is interpreted like a search query on the Sribd website.

scope

A character string containing either “new” or “hot”.

sort

A character string containing one of “popular”, “views”, or “newest”.

limit

For results pagination, a numeric value indicating the number of result to return. Must be less than 1000.

offset

For results pagination, a numeric value indicating the initial result to return. Must be less than 1000.

...

Other arguments passed to HTTP request functions.

Details

docs_search allows for searches of all documents on Scribd based on a search query, category restrictions, and language restrictions.

docs_featured returns a list of featured documents based on time or popularity.

docs_browse returns a list of documents based on time, views, or popularity.

docs_list returns a list of the user's own documents.

All of these functions can be paginated using the limit (page size) and offset (page start) parameters. For example, a call with limit = 20, offset = 0 returns the first 20 results. A subsequent call to limit = 20, offset = 20 returns the next 20 results.

Value

A list of objects of class “scribd_doc”.

Author(s)

Thomas J. Leeper

References

API Reference: docs.search

API Reference: docs.featured

API Reference: docs.browse

API Reference: docs.getList

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## Not run: 
# get your own documents
docs_list()

# search public documents
docs_search("John Chambers")

# featured documents
docs_featured()

## End(Not run)

cloudyr/rscribd documentation built on May 13, 2019, 8:22 p.m.