Skip to content

Commit

Permalink
fix #4 export proof_header and tweak docs a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
sckott committed Jan 10, 2024
1 parent 507a302 commit 0711db2
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 10 deletions.
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

export(proof_authenticate)
export(proof_cancel)
export(proof_header)
export(proof_start)
export(proof_status)
importFrom(httr,DELETE)
Expand Down
8 changes: 2 additions & 6 deletions R/auth.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,8 @@ find_token <- function(token = NULL) {

#' Get header for PROOF API calls
#'
#' Utility method to get header for PROOF API calls
#'
#' @keywords internal
#' @param token PROOF API token
#' @export
#' @param token (character) PROOF API token. optional
#' @return A `request` S3 class with the HTTP header that can be passed
#' to `httr::GET()`, `httr::POST()`, etc.
proof_header <- function(token = NULL) {
Expand All @@ -23,8 +21,6 @@ proof_header <- function(token = NULL) {

#' Authenticate with PROOF API
#'
#' Authenticates with HutchNet credentials, returns PROOF API token
#'
#' @export
#' @param username (character) HutchNet username
#' @param password (character) HutchNet password
Expand Down
2 changes: 1 addition & 1 deletion man/proof_authenticate.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 2 additions & 3 deletions man/proof_header.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 0711db2

Please sign in to comment.