Fix documentation

matbarofex · Apr 30, 2020 · f0187b9 · f0187b9
1 parent cb36a05
commit f0187b9
Show file tree

Hide file tree

Showing 26 changed files with 137 additions and 25 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: rRofex
 Type: Package
 Title: Interface to ROFEX APIs
-Version: 1.5.0
+Version: 1.5.1
 Authors@R: c(person("Augusto", "Hassel", role = c("aut", "cre"), email = "[email protected]"))
 Description: Provides a convenient wrapper for consuming data from ROFEX APIs: Trading API, Risk API and BackOffice API.
 License: MIT

diff --git a/NAMESPACE b/NAMESPACE
@@ -23,6 +23,7 @@ importFrom(purrr,map)
 importFrom(purrr,map_df)
 importFrom(purrr,modify_depth)
 importFrom(purrr,pluck)
+importFrom(purrr,simplify_all)
 importFrom(purrr,some)
 importFrom(rlang,is_null)
 importFrom(tibble,as_tibble)

diff --git a/R/functions.R b/R/functions.R
@@ -784,7 +784,7 @@ trading_orders <- function(connection, account) {
 #'
 #' @param connection S4. \strong{Mandaroty} Formal rRofexConnection class object
 #' @param account String. \strong{Mandaroty} Account Number
-#' @param account Logical. Expanded information.
+#' @param detailed Logical. Expanded information.
 #'
 #' @return If correct, it will load a tibble.
 #'
@@ -863,3 +863,108 @@ trading_account <- function(connection, account, detailed = FALSE) {
 
   return(data)
 }
+
+#' @title Account Report
+#'
+#' @description Access report about your trading account.
+#'
+#' @param connection S4. \strong{Mandaroty} Formal rRofexConnection class object
+#' @param account String. \strong{Mandaroty} Account Number
+#'
+#' @return If correct, it will load a tibble.
+#'
+#' @family account functions
+# trading_account_report <- function(connection, account) {
+#
+#   if (missing(connection)) stop("Connection cannot be empty.")
+#   if (!isS4(connection) || rev(class(connection)) != "rRofexConnection" || !validObject(connection)) stop("The 'connection' must be a valid 'rRofexConnection'.")
+#   if (as.Date(connection@login_date_time) != Sys.Date()) stop("The 'acyRsaConnection' is no longer valid. Please log-in again.")
+#
+#   if (missing(account)) stop("'account' parameter cannot be empty.")
+#
+#   # Query
+#   query <- GET(url = glue(connection@base_url, "/rest/risk/accountReport/{account}"),
+#                add_headers(.headers = c("X-Auth-Token" = connection@token)))
+#
+#   if (status_code(query) != 200) {
+#
+#     warn_for_status(query)
+#     message("\r")
+#     data <- NULL
+#
+#   } else {
+#
+#     data <- fromJSON(toJSON(content(query), auto_unbox = T, null = "null"))
+#
+#     data <- if (length(data$accountData)) {
+#
+#       data$accountData %>%
+#         t() %>%
+#         as_tibble() %>%
+#         mutate_if(., .predicate = ~ class(.) == 'list', .funs = ~ replace_na(data = ., replace = NA)) %>%
+#         mutate_if(., .predicate = ~ length(unlist(.)) == 1, .funs =  ~ unlist(x = ., recursive = F)) %>%
+#         mutate_at(.tbl = ., .vars = vars(matches("detailedAccountReports")), .funs = ~ list(
+#           unlist(x = ., recursive = F) %>%
+#             as_tibble() %>%
+#             pivot_longer(cols = everything(), names_to = "Term", values_to = "values") %>%
+#             mutate(
+#               Term = as.integer(Term),
+#               Names = unlist(attributes(values))
+#               ) %>%
+#             pivot_wider(data = ., values_from = values, names_from = Names) %>%
+#             mutate(
+#               settlementDate = as.POSIXct(unlist(settlementDate)/1000, origin = "1970-01-01", tz = "America/Buenos_Aires")
+#             )
+#         )) %>%
+#         select(detailedAccountReports) %>%
+#         pluck(1)
+#
+#         test
+#
+#
+#         pija <- test[[1]] %>%
+#           mutate(
+#             currencyBalance = map(currencyBalance, .f = ~ unlist(., recursive = F) %>% as_tibble())
+#           )
+#
+#
+#         pija$currencyBalance[[1]] %>%
+#
+#
+#
+#
+#
+#
+#           mutate(
+#             currencyBalance = map(currencyBalance, .f = ~ purrr::flatten(.) %>% as_tibble())
+#           ) #%>%
+#           mutate(
+#             currencyBalance = modify_depth(currencyBalance, .depth = 1, .f = ~ unnest(.))
+#             )
+#
+#
+#
+#
+#
+# list(unlist(. %>% pluck(1), recursive = F) %>% purrr::map_df(., .f = ~ pluck(.) %>% as_tibble())
+#
+#       mutate_if(., .predicate = ~ class(.[[1]]) == 'list', .funs = ~ modify_depth(.x = ., .depth = 1, ~ replace_na(data = ., replace = NA_real_)))
+#
+#
+#                 t() %>%
+#         as_tibble() %>%
+#         mutate_if(., .predicate = ~ length(unlist(.)) == 1, .funs =  ~ unlist(x = ., recursive = F)) %>%
+#         mutate_if(., .predicate = ~ any(map(.[[1]], .f = ~ length(.)) > 1), .funs = ~ list(unlist(.[[1]], recursive = F))) %>%
+#         mutate(report = list(unlist(report, recursive = F) %>% purrr::map_df(., .f = ~ pluck(., "detailedPositions")) %>% as_tibble())) %>%
+#         mutate(lastCalculation = as.POSIXct(lastCalculation/1000, origin = "1970-01-01", tz = "America/Buenos_Aires")) %>%
+#         mutate_at(.tbl = ., .vars = vars(matches("report")), .funs = ~ modify_depth(.x = ., .depth = 1, ~ mutate_at(.tbl = ., .vars = vars(matches("date")), .funs = ~ as.POSIXct(./1000, origin = "1970-01-01", tz = "America/Buenos_Aires"))))
+#     } else {
+#       message("No data available at the moment...")
+#       NULL
+#     }
+#
+#
+#   }
+#
+#   return(data)
+# }
diff --git a/R/rRofex.R b/R/rRofex.R
@@ -5,6 +5,6 @@
 #' @importFrom tidyr separate replace_na pivot_wider
 #' @importFrom magrittr %>%
 #' @importFrom glue glue glue_collapse
-#' @importFrom purrr some modify_depth map_df pluck map
+#' @importFrom purrr some modify_depth map_df pluck map simplify_all
 #' @importFrom rlang is_null
 "_PACKAGE"
diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/CODE_OF_CONDUCT.html b/docs/CODE_OF_CONDUCT.html
diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html
diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 2.7.2
 pkgdown: 1.5.1
 pkgdown_sha: ~
 articles: []
-last_built: 2020-04-30T00:57Z
+last_built: 2020-04-30T01:03Z
 
diff --git a/docs/reference/index.html b/docs/reference/index.html
diff --git a/docs/reference/rRofex-package.html b/docs/reference/rRofex-package.html
diff --git a/docs/reference/rRofex_connection.html b/docs/reference/rRofex_connection.html
diff --git a/docs/reference/trading_account.html b/docs/reference/trading_account.html
diff --git a/docs/reference/trading_cancel_order.html b/docs/reference/trading_cancel_order.html
diff --git a/docs/reference/trading_currencies.html b/docs/reference/trading_currencies.html
diff --git a/docs/reference/trading_instruments.html b/docs/reference/trading_instruments.html
diff --git a/docs/reference/trading_instruments_fronts.html b/docs/reference/trading_instruments_fronts.html
diff --git a/docs/reference/trading_login.html b/docs/reference/trading_login.html
diff --git a/docs/reference/trading_lookup.html b/docs/reference/trading_lookup.html
diff --git a/docs/reference/trading_md.html b/docs/reference/trading_md.html
diff --git a/docs/reference/trading_mdh.html b/docs/reference/trading_mdh.html
diff --git a/docs/reference/trading_new_order.html b/docs/reference/trading_new_order.html
diff --git a/docs/reference/trading_orders.html b/docs/reference/trading_orders.html
diff --git a/man/trading_account.Rd b/man/trading_account.Rd