api_order: Parse DHIS2 order

In INyabuto/dhis2r: An R Client for DHIS2 Web API

Description

Short hand for specifying an order parameter in an api_query.

Usage

api_order(x, by = c("asc", "iasc", "desc", "idesc"))

Arguments

x	An endpoint field.
by	Type of ordering. Use 'asc' to order in ascending order, 'desc' in descending order. The variants 'iasc' and 'idesc' are case insensitive.

Examples

# order name in ascending order
api_order("name", by = "asc")
# order name in descending order
api_order("name", by = "desc")
# example in a query to order by ascending order
api_query(order = api_order("name", "asc"))
# order data elements in descending order
modify_endpoint(endpoint = "dataElements", order = api_order("name", "desc"))

INyabuto/dhis2r documentation built on June 14, 2021, 1:15 a.m.