[Blotter-commits] r1042 - in pkg/FinancialInstrument: R man

[noreply at r-forge.r-project.org]

Author: gsee
Date: 2012-06-06 01:04:48 +0200 (Wed, 06 Jun 2012)
New Revision: 1042

Modified:
   pkg/FinancialInstrument/R/load.instruments.R
   pkg/FinancialInstrument/R/update_instruments.yahoo.R
   pkg/FinancialInstrument/man/getSymbols.FI.Rd
   pkg/FinancialInstrument/man/load.instruments.Rd
   pkg/FinancialInstrument/man/setSymbolLookup.FI.Rd
   pkg/FinancialInstrument/man/update_instruments.masterDATA.Rd
Log:
 minor updates to docs

Modified: pkg/FinancialInstrument/R/load.instruments.R
===================================================================
--- pkg/FinancialInstrument/R/load.instruments.R	2012-06-05 15:47:36 UTC (rev 1041)
+++ pkg/FinancialInstrument/R/load.instruments.R	2012-06-05 23:04:48 UTC (rev 1042)
@@ -39,9 +39,10 @@
 #' @param id_col numeric column containing id if primary_id isn't defined, default 1
 #' @param default_type character string to use as instrument type fallback, see Details
 #' @seealso 
-#' \code{\link{instrument}} 
-#' \code{\link{setSymbolLookup.FI}} 
-#' \code{\link[quantmod]{getSymbols}} 
+#' \code{\link{loadInstruments}},
+#' \code{\link{instrument}}, 
+#' \code{\link{setSymbolLookup.FI}}, 
+#' \code{\link[quantmod]{getSymbols}}, 
 #' \code{\link{getSymbols.FI}}
 #' @examples
 #' \dontrun{
@@ -156,9 +157,10 @@
 #' @param use_identifier string identifying which column should be use to construct the \code{primary_id} of the instrument, default 'primary_id'
 #' @param extension file extension, default "rda"
 #' @param src which \code{\link[quantmod]{getSymbols}} sub-type to use, default \code{\link{getSymbols.FI}} by setting 'FI'
-#' @seealso \code{\link{load.instruments}} 
-#' \code{\link{getSymbols.FI}}
-#' \code{\link{load.instruments}}
+#' @seealso 
+#' \code{\link{getSymbols.FI}},
+#' \code{\link{instrument_attr}},
+#' \code{\link{load.instruments}}, \code{\link{loadInstruments}},
 #' \code{\link[quantmod]{setSymbolLookup}}
 #' @importFrom zoo as.Date
 #' @export
@@ -267,7 +269,7 @@
 #' \code{\link{saveSymbols.days}}
 #' \code{\link{instrument}}
 #' \code{\link{setSymbolLookup.FI}}
-#' \code{\link{load.instruments}}
+#' \code{\link{loadInstruments}}
 #' \code{\link[quantmod]{getSymbols}}
 #' @export
 getSymbols.FI <- function(Symbols,

Modified: pkg/FinancialInstrument/R/update_instruments.yahoo.R
===================================================================
--- pkg/FinancialInstrument/R/update_instruments.yahoo.R	2012-06-05 15:47:36 UTC (rev 1041)
+++ pkg/FinancialInstrument/R/update_instruments.yahoo.R	2012-06-05 23:04:48 UTC (rev 1042)
@@ -222,6 +222,8 @@
 #' @author Garrett See
 #' @references \url{http://masterDATA.com} 
 #' (\url{http://www.masterdata.com/helpfiles/ETF_List_Downloads/AllTypes.csv})
+#' @seealso \code{\link{update_instruments.yahoo}}, 
+#'   \code{\link{update_instruments.instrument}}
 #' @examples
 #' \dontrun{
 #' stock(s <- c("SPY", "DIA"), currency("USD"))

Modified: pkg/FinancialInstrument/man/getSymbols.FI.Rd
===================================================================
--- pkg/FinancialInstrument/man/getSymbols.FI.Rd	2012-06-05 15:47:36 UTC (rev 1041)
+++ pkg/FinancialInstrument/man/getSymbols.FI.Rd	2012-06-05 23:04:48 UTC (rev 1042)
@@ -93,7 +93,7 @@
 \seealso{
   \code{\link{saveSymbols.days}} \code{\link{instrument}}
   \code{\link{setSymbolLookup.FI}}
-  \code{\link{load.instruments}}
+  \code{\link{loadInstruments}}
   \code{\link[quantmod]{getSymbols}}
 }
 

Modified: pkg/FinancialInstrument/man/load.instruments.Rd
===================================================================
--- pkg/FinancialInstrument/man/load.instruments.Rd	2012-06-05 15:47:36 UTC (rev 1041)
+++ pkg/FinancialInstrument/man/load.instruments.Rd	2012-06-05 23:04:48 UTC (rev 1042)
@@ -62,8 +62,9 @@
 }
 }
 \seealso{
-  \code{\link{instrument}} \code{\link{setSymbolLookup.FI}}
-  \code{\link[quantmod]{getSymbols}}
+  \code{\link{loadInstruments}}, \code{\link{instrument}},
+  \code{\link{setSymbolLookup.FI}},
+  \code{\link[quantmod]{getSymbols}},
   \code{\link{getSymbols.FI}}
 }
 

Modified: pkg/FinancialInstrument/man/setSymbolLookup.FI.Rd
===================================================================
--- pkg/FinancialInstrument/man/setSymbolLookup.FI.Rd	2012-06-05 15:47:36 UTC (rev 1041)
+++ pkg/FinancialInstrument/man/setSymbolLookup.FI.Rd	2012-06-05 23:04:48 UTC (rev 1042)
@@ -56,9 +56,10 @@
   data by days, which is why that option is the default.
 }
 \seealso{
-  \code{\link{load.instruments}}
-  \code{\link{getSymbols.FI}}
-  \code{\link{load.instruments}}
+  \code{\link{getSymbols.FI}},
+  \code{\link{instrument_attr}},
+  \code{\link{load.instruments}},
+  \code{\link{loadInstruments}},
   \code{\link[quantmod]{setSymbolLookup}}
 }
 

Modified: pkg/FinancialInstrument/man/update_instruments.masterDATA.Rd
===================================================================
--- pkg/FinancialInstrument/man/update_instruments.masterDATA.Rd	2012-06-05 15:47:36 UTC (rev 1041)
+++ pkg/FinancialInstrument/man/update_instruments.masterDATA.Rd	2012-06-05 23:04:48 UTC (rev 1042)
@@ -71,4 +71,8 @@
   \url{http://masterDATA.com}
   (\url{http://www.masterdata.com/helpfiles/ETF_List_Downloads/AllTypes.csv})
 }
+\seealso{
+  \code{\link{update_instruments.yahoo}},
+  \code{\link{update_instruments.instrument}}
+}