examples added

Author: paulsp94

R/index.R

@@ -7,6 +7,10 @@
 #' @param token The user access token that can be retrieved with the auth() function. Required when if the database rules specify the need for user authentications. {string}
 #' @return returns http request answer which includes the random key.
 #' @export
+#' @examples
+#' \dontrun{
+#' upload(x = mtcars, projectURL = "https://firedata-b0e54.firebaseio.com/", directory = "main")
+#' }
 upload <- function(x, projectURL, directory = "main", token = "none"){
  output = fileConversion(x)
  if (token == "none") {
@@ -38,6 +42,10 @@ fileConversion <- function(x){
 #' @param isClass In case a s4 class object is downloaded, fireData expects a isClass=TRUE
 #' @return returns optionally reformatted data.
 #' @export
+#' @examples
+#' \dontrun{
+#' download(projectURL = "https://firedata-b0e54.firebaseio.com/", fileName = "main/-KxwWNTVdplXFRZwGMkH")
+#' }
 download <- function(projectURL, fileName, secretKey = "none", token = "none", isClass = FALSE) {
 
    if (secretKey == "none" && token == "none") {
@@ -68,6 +76,11 @@ download <- function(projectURL, fileName, secretKey = "none", token = "none", i
 #' @description The backup functionality allows to download the whole database into a .json file (which can later be uploaded in the firebase console to do a restore of the DB). Generally this function may allow to save costs by not relying on the Firebase automatic backup function that is only available with the Firebase Blaze premium payment contract.
 #' @return Returns either a warning or the backup file name.
 #' @export
+#' @examples
+#' \dontrun{
+#' dataBackup(projectURL = "https://firedata-efa5a.firebaseio.com", secretKey = "2bYA6k72wKna90MqPGa6yuMG7jAysoDJZwJqYXsm", "test.json")
+#' }
+
 dataBackup <- function(projectURL, secretKey="prompt", fileName){
   if (secretKey == "prompt") {
     secretKey <- readline(prompt = "secretKey: ")
@@ -88,6 +101,10 @@ dataBackup <- function(projectURL, secretKey="prompt", fileName){
 #' @param password The user password {string}
 #' @return Returns the content of the firebase API request, such as the state of registration, idToken, and validity of the user password.
 #' @export
+#' @examples
+#' \dontrun{
+#' auth(projectAPI = "AIzaSyAjZLO9-CRV3gObpwdFz-k8AiTOxHSBmdc", email = "[email protected]", password = "12341234")
+#' }
 auth <- function(projectAPI, email="prompt", password="prompt"){
   if (password == "prompt" && email == "prompt") {
         email <- readline(prompt = "Email: ")
@@ -106,6 +123,10 @@ auth <- function(projectAPI, email="prompt", password="prompt"){
 #' @description Creates a new firebase user account. All user accounts can accessed at the firebase.com project console. One of the advantages of firebase accounts in R is the ability to access a website and analyse the data of the website with the very same login.
 #' @return Registers a new user and returns the status.
 #' @export
+#' @examples
+#' \dontrun{
+#' createUser(projectAPI = "AIzaSyAjZLO9-CRV3gObpwdFz-k8AiTOxHSBmdc", email = "[email protected]", password = "12341234" )
+#' }
 createUser <- function(projectAPI, email="prompt", password="prompt"){
   if (password == "prompt" && email == "prompt") {
     email <- readline(prompt = "Email: ")
@@ -123,6 +144,10 @@ createUser <- function(projectAPI, email="prompt", password="prompt"){
 #' @description Resets the user password and sends an email to the user account.
 #' @return Success or warning message.
 #' @export
+#' @examples
+#' \dontrun{
+#' resetPassword(projectAPI = "AIzaSyAjZLO9-CRV3gObpwdFz-k8AiTOxHSBmdc", email = "[email protected]")
+#' }
 resetPassword <- function(projectAPI, email){
   AuthUrl = paste0("https://www.googleapis.com/identitytoolkit/v3/relyingparty/getOobConfirmationCode?key=", projectAPI)
   userData = httr::POST(url = AuthUrl, body = list("email" = email, "requestType" = "PASSWORD_RESET"), encode = "json")