smif.package: SMIF Risk Team Function Storage

#' SMIF Function and Documentation Package
#'
#' The \code{smif.package} allows members of the SMIF Risk and Asset Allocation teams to store commonly used functions and
#' datasets for use accross multiple devices and within RShiny projects.
#'
#' @details
#' \tabular{ll}{
#'   Package: \tab smif.package \cr
#'   Type: \tab Package \cr
#'   Version: \tab 0.2-01 \cr
#'   Date: \tab 2017-10-23 \cr
#'   License: \tab GPL-3 + file LICENSE \cr
#'   Depends: \tab magrittr(>=1.5) \cr
#'   URL: \tab https://github.com/alec25/smif.package \cr
#' }
#'
#' The package will be hosted on github, and the latest version can be downloaded with the following code:
#' \code{devtools::install_github('alec25/smif.package', dependencies=TRUE, upgrade_dependencies=TRUE)}
#'
#' @section Functions:
#'
#' The current master functions held by \code{smif.package} are as follows:
#' \describe{
#'   \item{\code{\link{getConstituents}}}{Returns the current constituents for a given index}
#'   \item{\code{\link{getSectorWeights}}}{Returns the sector weightings for a given index}
#'   \item{\code{\link{getStockInfo}}}{Returns info for a specified stock}
#'   \item{\code{\link{getServerData}}}{Returns current SMIF holdings or cash balance history}
#'   \item{\code{\link{getSectorETF}}}{Returns the S&P ETF for a given sector}
#'   \item{\code{\link{getSlides}}}{Returns the figures needed for pitch risk slides}
#'   \item{\code{\link{getStops}}}{Returns the VALOS stops for a given stock}
#'
#' }
#' The current datasets provided by \code{smif.package} are:
#' \describe{
#'   \item{\code{\link{smif_aa}}}{Assorted datasets with Asset Allocation applications}
#' }
#' @name smif.package
#' @docType package
"_PACKAGE"
#(TODO):
#
# # ROxygen2 documentation for getSlides
# # finish getPVaR (get better name for it)
# # good name for getPVaR
#
#
# # Add Google's R-Style Guide's internal comments for (all) functions
#
# # Test the 3 companies we need results for
#
# # Add @import / @importFrom statements to all function pages
#
# # library( profvis ) optimization
#
#
#
#
#
#