khis_display_name {khisr} | R Documentation |
Retrieve the Configured Display Name
Description
This function returns the display name from the configured profile in the provided
auth object. If auth
is not provided, it falls back to the global auth credentials.
Usage
khis_display_name(auth = NULL)
Arguments
auth |
(Optional) An auth object containing DHIS2 credentials. If not provided, the function retrieves the display name from the global auth object. |
Value
The display name as a string, or NULL
if no profile or display name is available.
See Also
Other credential functions:
khis_base_url()
,
khis_cred()
,
khis_cred_clear()
,
khis_has_cred()
,
khis_username()
Examples
## Not run:
# Set the credentials using global .auth object
khis_cred(username = 'DHIS2 username',
password = 'DHIS2 password',
base_url = 'https://dhis2-instance/api')
# Retrieve the display name from the global .auth profile
khis_display_name()
# Clear credentials
khis_cred_clear()
# Retrieve the display name again (expect 'NULL')
khis_display_name()
## End(Not run)
[Package khisr version 1.0.6 Index]