From 1370bc08fbb82ea297bfa84cad94ef70d554890c Mon Sep 17 00:00:00 2001 From: buhly Date: Thu, 12 Dec 2024 18:38:13 +0100 Subject: [PATCH] roxygenise --- man/gen_auth_save.Rd | 7 ++++++- man/insert_and_save_credentials.Rd | 4 +++- man/set_credentials_auth.Rd | 20 ++++++++++++++++++++ 3 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 man/set_credentials_auth.Rd diff --git a/man/gen_auth_save.Rd b/man/gen_auth_save.Rd index 2fd8ebb..041408b 100644 --- a/man/gen_auth_save.Rd +++ b/man/gen_auth_save.Rd @@ -4,10 +4,15 @@ \alias{gen_auth_save} \title{gen_auth_save} \usage{ -gen_auth_save(database = c("all", "genesis", "zensus", "regio")) +gen_auth_save( + database = c("all", "genesis", "zensus", "regio"), + use_token = FALSE +) } \arguments{ \item{database}{Character string. The database to store credentials for ('all', 'genesis', 'zensus' or 'regio').} + +\item{use_token}{Boolean. Do you want to (if possible) set an API token instead of password + username? Note: This is not supported by regionalstatistik.de. Defaults to FALSE.} } \value{ Path to the RDS file in which credentials are saved, invisibly. diff --git a/man/insert_and_save_credentials.Rd b/man/insert_and_save_credentials.Rd index 7778e79..fcd4f58 100644 --- a/man/insert_and_save_credentials.Rd +++ b/man/insert_and_save_credentials.Rd @@ -4,10 +4,12 @@ \alias{insert_and_save_credentials} \title{insert_and_save_credentials} \usage{ -insert_and_save_credentials(database) +insert_and_save_credentials(database, use_token) } \arguments{ \item{database}{The database to specify credentials for} + +\item{use_token}{Boolean. Do you want to (if possible) set an API token instead of password + username? Defaults to FALSE.} } \description{ insert_and_save_credentials diff --git a/man/set_credentials_auth.Rd b/man/set_credentials_auth.Rd new file mode 100644 index 0000000..fe3004b --- /dev/null +++ b/man/set_credentials_auth.Rd @@ -0,0 +1,20 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/utils_httr2.R +\name{set_credentials_auth} +\alias{set_credentials_auth} +\title{set_credentials_auth} +\usage{ +set_credentials_auth(path, sys_env, ui_menu_database, use_token) +} +\arguments{ +\item{path}{Path for the .rds file} + +\item{sys_env}{System environment variable name for the key} + +\item{ui_menu_database}{The database for the auth request ('GENESIS' or 'Zensus 2022')} + +\item{use_token}{Boolean. Do you want to (if possible) set an API token instead of password + username? Defaults to FALSE.} +} +\description{ +set_credentials_auth +}