diff --git a/hakaiApi/DESCRIPTION b/hakaiApi/DESCRIPTION index c76b643..3f50e0f 100644 --- a/hakaiApi/DESCRIPTION +++ b/hakaiApi/DESCRIPTION @@ -35,6 +35,6 @@ VignetteBuilder: knitr Encoding: UTF-8 Language: en-CA -RoxygenNote: 7.3.2 +RoxygenNote: 7.3.3 Config/testthat/edition: 3 Config/Needs/website: rmarkdown diff --git a/hakaiApi/R/client.R b/hakaiApi/R/client.R index c8f5b82..0de2d6a 100644 --- a/hakaiApi/R/client.R +++ b/hakaiApi/R/client.R @@ -49,9 +49,9 @@ Client <- R6::R6Class( #' @description #' Log into Google to gain credential access to the API #' @param api_root Optional API base url to fetch data. - #' Defaults to "https://hecate.hakai.org/api" + #' Defaults to "https://portal.hakai.org/api" #' @param login_page Optional API login page url to display to user. - #' Defaults to "https://hecate.hakai.org/api-client-login" + #' Defaults to "https://portal.hakai.org/api-client-login" #' @param credentials_file Optional path to the credentials cache file. #' Defaults to a file in the user's data directory as determined by tools::R_user_dir() #' @details @@ -74,8 +74,8 @@ Client <- R6::R6Class( #' client <- Client$new(credentials_file = "/path/to/creds") #' ) initialize = function( - api_root = "https://hecate.hakai.org/api", - login_page = "https://hecate.hakai.org/api-client-login", + api_root = "https://portal.hakai.org/api", + login_page = "https://portal.hakai.org/api-client-login", credentials_file = NULL ) { self$api_root <- api_root @@ -105,7 +105,7 @@ Client <- R6::R6Class( #' @return A dataframe of the requested data #' @examples #' try(client$get("/aco/views/projects")) - #' try(client$get("https://hecate.hakai.org/api/aco/views/projects")) + #' try(client$get("https://portal.hakai.org/api/aco/views/projects")) get = function(endpoint_url, col_types = NULL) { resolved_url <- private$resolve_url(endpoint_url) token <- paste( diff --git a/hakaiApi/README.md b/hakaiApi/README.md index 0571df6..3f1562b 100644 --- a/hakaiApi/README.md +++ b/hakaiApi/README.md @@ -24,7 +24,7 @@ remotes::install_github("HakaiInstitute/hakai-api-client-r", subdir='hakaiApi') ```r # Initialize the client -client <- hakaiApi::Client$new("https://hecate.hakai.org") +client <- hakaiApi::Client$new("https://portal.hakai.org") # Request some data (request chlorophyll data here) data <- client$get("api/eims/views/output/chlorophyll?limit=50") @@ -47,7 +47,7 @@ For details about the API, including available endpoints where data can be reque ## Advanced usage -You can specify which API to access when instantiating the Client. By default, the API uses `https://hecate.hakai.org/api` as the API root. It may be useful to use this library to access a locally running API instance or to access the Goose API for testing purposes. +You can specify which API to access when instantiating the Client. By default, the API uses `https://portal.hakai.org/api` as the API root. It may be useful to use this library to access a locally running API instance or to access the Goose API for testing purposes. ```r # Get a client for a locally running API instance diff --git a/hakaiApi/man/Client.Rd b/hakaiApi/man/Client.Rd index fd1ce9d..9a0412d 100644 --- a/hakaiApi/man/Client.Rd +++ b/hakaiApi/man/Client.Rd @@ -63,7 +63,7 @@ try( ## ------------------------------------------------ try(client$get("/aco/views/projects")) -try(client$get("https://hecate.hakai.org/api/aco/views/projects")) +try(client$get("https://portal.hakai.org/api/aco/views/projects")) ## ------------------------------------------------ ## Method `Client$get_stations` @@ -106,8 +106,8 @@ try( Log into Google to gain credential access to the API \subsection{Usage}{ \if{html}{\out{
}}\preformatted{Client$new( - api_root = "https://hecate.hakai.org/api", - login_page = "https://hecate.hakai.org/api-client-login", + api_root = "https://portal.hakai.org/api", + login_page = "https://portal.hakai.org/api-client-login", credentials_file = NULL )}\if{html}{\out{
}} } @@ -116,10 +116,10 @@ Log into Google to gain credential access to the API \if{html}{\out{
}} \describe{ \item{\code{api_root}}{Optional API base url to fetch data. -Defaults to "https://hecate.hakai.org/api"} +Defaults to "https://portal.hakai.org/api"} \item{\code{login_page}}{Optional API login page url to display to user. -Defaults to "https://hecate.hakai.org/api-client-login"} +Defaults to "https://portal.hakai.org/api-client-login"} \item{\code{credentials_file}}{Optional path to the credentials cache file. Defaults to a file in the user's data directory as determined by tools::R_user_dir()} @@ -180,7 +180,7 @@ A dataframe of the requested data \subsection{Examples}{ \if{html}{\out{
}} \preformatted{try(client$get("/aco/views/projects")) -try(client$get("https://hecate.hakai.org/api/aco/views/projects")) +try(client$get("https://portal.hakai.org/api/aco/views/projects")) } \if{html}{\out{
}} diff --git a/hakaiApi/vignettes/articles/Viewing-Recent-Stations.Rmd b/hakaiApi/vignettes/articles/Viewing-Recent-Stations.Rmd index 88dd703..b19f675 100644 --- a/hakaiApi/vignettes/articles/Viewing-Recent-Stations.Rmd +++ b/hakaiApi/vignettes/articles/Viewing-Recent-Stations.Rmd @@ -23,7 +23,7 @@ We first need to access the stations endpoint using the `Client` class from the ```{r get-data} #| eval: FALSE -hakai_client <- hakaiApi::Client$new("https://hecate.hakai.org/api") +hakai_client <- hakaiApi::Client$new("https://portal.hakai.org/api") stations <- hakai_client$get_stations() ```