# ----------------------------------------------------------------------------
# marketconf PACKAGE
# Stock Market Confidence Indices in R
# File: get_index_info.R
# (c) 2018 - Enrique PĂ©rez Herrero
# email: eph.project1500@gmail.com
# The MIT License (MIT)
# ------------------------------------------------------------------------
#' Find Confidence Index information
#'
#' @inheritParams US_confidence_indices_url
#' @md
#' @note The default value for \code{symbol} is "US1YI".
#' @importFrom magrittr "%>%" extract2
#' @importFrom dplyr filter select
#' @return A string with the Confidence Index description
#' @seealso \code{\link{US_confidence_indices}}
#' @seealso \code{\link{get_index}}
#' @seealso \code{\link{get_index_description}}
#' @seealso \code{\link{check_index_symbol}}
#'
#' @examples
#' get_index_info("USCI")
#' @export
get_index_info <- function(symbol = "US1YI") {
Symbol <- NULL
Info <- NULL
US_confidence_indices() %>%
dplyr::filter(Symbol == check_index_symbol(symbol)) %>%
dplyr::select(Info) %>%
magrittr::extract2(1L)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.