wastdr_setup: Configure default WAStD settings

In dbca-wa/wastdr: WA Sea Turtle Database 'WAStD' API Wrapper

Configure default WAStD settings

Description

Configure default WAStD settings

Usage

wastdr_setup(
  wastd_url = get_wastd_url(),
  api_url = get_wastdr_api_url(),
  api_token = NULL,
  api_un = get_wastdr_api_un(),
  api_pw = get_wastdr_api_pw()
)

Arguments

wastd_url	A WAStD URL (optional), default: "https://wastd.dbca.wa.gov.au"
api_url	A WAStD API URL (optional), default: "https://wastd.dbca.wa.gov.au/api/1/"
api_token	A WAStD API token, optionally leading with "Token " (character)
api_un	Alternatively, a WAStD API username (character)
api_pw	The password to the WAStD username (character)

Details

wastdr_setup sets WAStD API connection details. wastdr's functions default to use the default URL, but require an API key to work.

See Also

Other helpers: absolute_angle(), add_dates(), datetime_as_isoweek(), datetime_as_seasonweek(), datetime_as_season(), datetime_as_turtle_date(), exclude_training_species(), exclude_training_surveys(), extract_possibly(), fdate_as_tdate(), filter_missing_site(), filter_missing_survey(), filter_surveys_missing_end(), filter_surveys_requiring_qa(), filter_wastd_season(), get_more(), gj_linestring_to_st_linestring(), httpdate_as_gmt08_turtle_date(), httpdate_as_gmt08(), httpdate_as_season(), humanize(), join_tsc_sites(), leaflet_basemap(), map_chr_hack(), mean_bearing(), mis_bearing(), odkc_works(), read_table(), sentencecase(), sf_as_tbl(), tdate_as_fdate(), tracks_as_geojson(), tun(), urlize(), verify_odkc_turtledata(), verify_wamtram_data(), verify_wastd_data(), wastd_works(), wastdr_msg_abort(), wastdr_msg_info(), wastdr_msg_noop(), wastdr_msg_success(), wastdr_msg_warn(), wastdr_settings()

Examples

# WAStD users with a DBCA account can access their WAStD authentication
# token on their profile page on WAStD:
wastdr_setup(api_token = "wastd_token")

# Non-DBCA users will have been given a WAStD username and password:
wastdr_setup(
  api_un = "wastd_username",
  api_pw = "wastd_password"
)

# Not specifying the default WAStD API URL will reset the WAStD URL to its
# default "https://wastd.dbca.wa.gov.au/api/1/":
## Not run: 
wastdr_setup(api_token = "c12345asdfqwer")

## End(Not run)

dbca-wa/wastdr documentation built on Nov. 20, 2022, 12:25 p.m.