bigml (version 0.1.2)

formEncodeURL: A simple function to turn named arguments into a form-encoded string

Description

A simple function to turn named arguments into a form-encoded string

Usage

formEncodeURL(a, ...)

Arguments

a

something

...

arbitrary named arguments that will become part of a form-encoded url.

Value

form-encoded string result

Details

This function is called in every BigML API function. It helps build the URL that requests are forwarded to. It automatically adds any default user and api key settings specified by setCredentials. However, it also can be used to access advanced options that are otherwise undocumented here. For instance, it's possible to filter and/or sort on a number of different api requests, using a number of different fields (e.g., see the documentation on listing and sorting datasets.) Other usage includes specifying username and api_key for individual API requests; or limit or offset parameters useful for paging through list requests. Finally, it's possible to enable a simple debug mode by passing debug=TRUE. This will print the url request string to the screen, along with any posted json objects.

Examples

## Not run: 
# formEncodeURL(username="user1", api_key="test", limit=100, debug=TRUE)
# # "?username=user1&api_key=test&limit=100&debug=TRUE"
# ## End(Not run)