Skip to contents

Retrieves Key resources from the Symbiota2 server

Source: R/Key.R
Key.Rd

Functions that retrieve Key resources from the server previously connected to. Each function either retrieves an individual resource or a page of resources, depending on the arguments provided.

Usage

CharacterHeading(id, page, url = NULL)

Characters(id, page, url = NULL)

CharacterStateImages(id, page, url = NULL)

CharacterStates(id, page, url = NULL)

DescriptionDeletions(id, page, url = NULL)

Arguments

id

id value (usually numeric, but not always) used to refer to the specific resource to pull from the database

page

numeric value referring to the page of resources to pull. If neither an id or a page parameter is provided, function will pull the first page of resources (i.e. page=1)

url

URL string of the Symbiota2 portal to be connected to. A trailing / will be appended, if it is not given.

Value

If using id, the specific resource specified; if using page, the page specified of resources

Note

To specify a default URL to refer to, see SymbiotaR2_setup()

Author

Austin Koontz

Examples

if (FALSE) {
# Pulling a Characters resource (id = 3), from a (nonexistent) dummy portal
object <- Characters(id = 3, url = "http://dummy-portal.com/api/")
}