stellaRbase (version 0.1.0)

getEffects: Returns all effects.

Description

Return all effects. Not all are visible on the public ledger.

Usage

getEffects(cursor = NULL, limit = 10, order = "asc", data.table = TRUE,
  stream = FALSE)

Arguments

cursor

numeric - optional, a paging token - where to start from. Can also be "now".

limit

numeric - optional, the number of records to return. Default is 10.

order

character - optional, "asc" or "desc"

data.table

boolean - if TRUE, a data.table is returned. If FALSE or NULL, a list is returned.

stream

boolean - if TRUE, a data.table is overwritten and the server-side streaming capability is utilised. A list will be returned.

Value

data.table or list

Examples

# NOT RUN {
getEffects(limit = 20, order = "asc")
# }