update examples (see #43) and show defined function args

braverock · Dec 10, 2021 · 8f0a506 · 8f0a506
1 parent 6207bc0
commit 8f0a506
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 5 deletions.
diff --git a/R/selectCRSPandSPGMI.R b/R/selectCRSPandSPGMI.R
@@ -21,14 +21,22 @@
 #'
 #' @return A merged data.frame consisting of selected stocks and factors
 #' 
-#' @export
-#'
 #'@examples
 #'data(stocksCRSP)
 #'data(factorsSPGMI)
 #'
-#'stocks_factors <- selectCRSPandSPGMI()
+#'stocks_factors <- selectCRSPandSPGMI(stocks = stocksCRSP, factors = factorsSPGMI,
+#'                                     dateSet = c("2006-01-31", "2010-12-31"), 
+#'                                     stockItems = c("Date", "TickerLast", 
+#'                                                    "CapGroup", "Sector", 
+#'                                                    "Return", "Ret13WkBill",
+#'                                                    "mktIndexCRSP"),
+#'                                     factorItems = c("BP", "LogMktCap", "SEV"), 
+#'                                     capChoice = "SmallCap",
+#'                                     Nstocks = 20)
 #'
+#'str(stocks_factors)
+#'@export
 selectCRSPandSPGMI <- function(stocks = stocksCRSP, factors = factorsSPGMI,
                                dateSet = c("2006-01-31","2010-12-31"), 
                                stockItems = c("Date", "TickerLast", "CapGroup",

diff --git a/man/selectCRSPandSPGMI.Rd b/man/selectCRSPandSPGMI.Rd