ed_auth: EIDITH logon credentials

View source: R/auth.R

ed_authR Documentation

EIDITH logon credentials

Description

Any function that downloads data from EIDITH, such as ed_db_download() or the raw download functions requires login credentials. These functions will ask for a username and password. To get an EIDITH account with data access permissions, contact technology@eidith.org.

Details

For frequent or programmatic use, we recommend caching your logon credentials as environment variables. eidith functions will automatically search for your credentials in the EIDITH_USERNAME and EIDITH_PASSWORD environment variables.

To cache your credentials across multiple R sessions, save them in your personal .Renviron file. You can also use the usethis package to easily access and edit your .Renviron file:

install.packages("usethis")
usethis::edit_r_environ()

This should open up your .Renviron file in a new tab, and you add the lines:

EIDITH_USERNAME=your_username
EIDITH_PASSWORD=your_password

Save this file, restart R, and you will be automatically logged in to download data from EIDITH when working on this computer.


ecohealthalliance/eidith documentation built on Aug. 30, 2022, 7:45 a.m.