cfUser-class {clifro} | R Documentation |
The Clifro User Object
Description
Create a cfUser
object to allow the user to log into CliFlo from R
and build their query.
Usage
cf_user(username = "public", password = character())
Arguments
username |
a character string to be used as the cliflo username |
password |
a character string to be used as the cliflo password |
Details
An object inheriting from the cfUser
class is created by the constructor
function cf_user
. The user must have an active subscription to cliflo
in order to create a valid object, unless a 'public' user is sought.
Visit https://cliflo.niwa.co.nz/ for more information and to subscribe
to cliflo.
Value
cfUser
object
Note
For the 'public' user (see examples) only the Reefton Ews station data is available.
See Also
valid_cfuser
for details on the validation of
cfUser
and summary,cfUser-method
to summarise user
information.
Examples
## Not run:
public.cfuser = cf_user(username = "public")
public.cfuser
## End(Not run)
[Package clifro version 3.2-5 Index]