R/dmaccess.R

In PrecisionLivestockManagement/DMMongoDB: Provides access to DataMuster MongoDB Atlas server

#' Set up access credentials for DataMuster database
#'
#' The function needs to be run first of all. It stores the credentials on the local machine to provide ongoing access to the DMMongoDB.
#' Please check with Lauren O'Connor \email{lauren.oconnor@@datamuster.net.au} to get login details and make sure you run this function before any others as it will be essential
#' to providing detailed access.
#'
#' @name dmaccess
#' @param user this is the username as a text string that you have been allocated to all access to the DataMuster MongoDB Atlas server
#' @param password you will be prompted to provide your password to be able to acces the MongoDB
#' @return this establishes username and password credentials on the local machine and avoids having to enter them everytime you use the DMMongoDB functions
#' @author Dave Swain \email{d.swain@@cqu.edu.au} and Lauren O'Connor \email{l.r.oconnor@@cqu.edu.au}
#' @import keyring
#' @export

dmaccess <- function(user){

  if (nrow(keyring::key_list("DMMongoDB"))!=0){
    username = keyring::key_list("DMMongoDB")[1,2]
    for(i in 1 :nrow(keyring::key_list("DMMongoDB")))
      keyring::key_delete("DMMongoDB", username)

  }

  keyring::key_set(service="DMMongoDB",username = user)

}