doc/pkgdown tweaks

jefferis · Mar 28, 2018 · 62108ff · 62108ff
1 parent 5523ab7
commit 62108ff
Show file tree

Hide file tree

Showing 19 changed files with 66 additions and 27 deletions.
diff --git a/R/ReadIgorBinary.R b/R/ReadIgorBinary.R
@@ -78,6 +78,7 @@
 #' # make a list containing the wave's data in the users's environment
 #' wavename=read.ibw(system.file("igor","version5.ibw",package="IgorR"),MakeWave=TRUE) 
 #' sum(get(wavename))
+#' @family igor-io
 read.ibw<-function(wavefile,Verbose=FALSE,ReturnTimeSeries=FALSE,
     MakeWave=FALSE,HeaderOnly=FALSE){
   if (is.character(wavefile)) {
@@ -152,6 +153,7 @@ read.ibw<-function(wavefile,Verbose=FALSE,ReturnTimeSeries=FALSE,
 #' @author jefferis
 #' @export
 #' @import bitops
+#' @family igor-io
 #' @examples 
 #' r=read.pxp(system.file("igor","testexpt.pxp",package="IgorR"))
 read.pxp<-function(pxpfile,regex,ReturnTimeSeries=FALSE,Verbose=FALSE,
@@ -786,17 +788,19 @@ if(R.version$major>2) {
 }
 
 #' Convert an Igor wave (wave list) loaded by read.ibw into an R time series
-#' 
-#' Where there are multiple waves, they are assumed to be of compatible lengths 
+#'
+#' Where there are multiple waves, they are assumed to be of compatible lengths
 #' so that they can be joined together by \code{cbind}.
-#' 
+#'
 #' @param WaveData, a wave or list of waves
 #' @param ReturnOriginalDataOnError If we can't make a time series, return
-#'  return original data (default TRUE)
-#' @return a time series or multi time series (\code{ts}, \code{mts})
+#'   return original data (default TRUE)
+#' @return a time series or multi time series (\code{\link[stats]{ts}},
+#'   \code{mts})
 #' @author jefferis
 #' @export
 #' @importFrom stats ts
+#' @family igor-io
 WaveToTimeSeries<-function(WaveData,ReturnOriginalDataOnError=TRUE){
   if(is.list(WaveData)) {
     # process separate waves into multi wave time series
@@ -817,7 +821,7 @@ WaveToTimeSeries<-function(WaveData,ReturnOriginalDataOnError=TRUE){
 #' @param wave Igor wave loaded by \code{read.ibw} or\code{read.pxp}
 #' @return numeric vector with elements start, end, frequency
 #' @author jefferis
-#' @seealso \code{\link{tsp}}
+#' @seealso \code{\link[stats]{tsp}}
 #' @export
 tsp.igorwave<-function(wave){
   bh=attr(wave,"BinHeader")

diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/reference/IgorR-package.html b/docs/reference/IgorR-package.html
diff --git a/docs/reference/IgorR-private.html b/docs/reference/IgorR-private.html
diff --git a/docs/reference/ReadAllNclampLogTables.html b/docs/reference/ReadAllNclampLogTables.html
diff --git a/docs/reference/ReadNclampLogTable.html b/docs/reference/ReadNclampLogTable.html
diff --git a/docs/reference/SummariseSweepFile.html b/docs/reference/SummariseSweepFile.html
diff --git a/docs/reference/SweepFilesToDataFrame.html b/docs/reference/SweepFilesToDataFrame.html
diff --git a/docs/reference/UpdateSweepDataFrame.html b/docs/reference/UpdateSweepDataFrame.html
diff --git a/docs/reference/WaveToTimeSeries.html b/docs/reference/WaveToTimeSeries.html
diff --git a/docs/reference/index.html b/docs/reference/index.html
diff --git a/docs/reference/read.ibw.html b/docs/reference/read.ibw.html
diff --git a/docs/reference/read.pxp.html b/docs/reference/read.pxp.html
diff --git a/docs/reference/tsp.igorwave.html b/docs/reference/tsp.igorwave.html
diff --git a/man/WaveToTimeSeries.Rd b/man/WaveToTimeSeries.Rd
diff --git a/man/read.ibw.Rd b/man/read.ibw.Rd
diff --git a/man/read.pxp.Rd b/man/read.pxp.Rd
diff --git a/man/tsp.igorwave.Rd b/man/tsp.igorwave.Rd