createcollection: Create/update/delete collection

In cloudyr/rscribd: Scribd API Client Package for R

Description

Create, update details of, or delete a collection

Usage

coll_create(name, description, access = "public", ...)

coll_update(id, name = NULL, description = NULL, access = NULL, ...)

coll_delete(id, ...)

Arguments

id	A collection id (or object of class “scribd_collection”) to either update or delete.
name	The name of the collection. This is optional for coll_update.
description	The description of the collection. This is optional for coll_update.
access	An access level for the collection; one of “public” (the default) or “private”. This is optional for coll_update.
...	Other arguments passed to HTTP request functions.

Details

These functions create a collection or update the details of an already created collection, or to delete a collection. To add or remove documents to/from a collection, use coll_add and coll_remove, respectively. To delete a document entirely, use doc_delete.

Author(s)

Thomas J. Leeper

References

API Reference: create

API Reference: update

API Reference: delete

See Also

coll_list, coll_docs

coll_add, coll_remove

Examples

## Not run: 
# create
mycoll <- coll_create("Rscribd Collection", "A simple example collection")

# update
coll_update(mycoll, access = "private")

# delete
coll_delete(mycoll)

## End(Not run)

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