From 62108ff12caa59f4163c96dbe89ef364c5b48db0 Mon Sep 17 00:00:00 2001 From: Gregory Jefferis Date: Wed, 28 Mar 2018 10:38:20 +0100 Subject: [PATCH] doc/pkgdown tweaks --- R/ReadIgorBinary.R | 16 ++++++++++------ docs/authors.html | 2 +- docs/index.html | 2 +- docs/reference/IgorR-package.html | 2 +- docs/reference/IgorR-private.html | 2 +- docs/reference/ReadAllNclampLogTables.html | 2 +- docs/reference/ReadNclampLogTable.html | 2 +- docs/reference/SummariseSweepFile.html | 2 +- docs/reference/SweepFilesToDataFrame.html | 2 +- docs/reference/UpdateSweepDataFrame.html | 2 +- docs/reference/WaveToTimeSeries.html | 16 ++++++++++++---- docs/reference/index.html | 2 +- docs/reference/read.ibw.html | 9 ++++++++- docs/reference/read.pxp.html | 9 ++++++++- docs/reference/tsp.igorwave.html | 4 ++-- man/WaveToTimeSeries.Rd | 9 +++++++-- man/read.ibw.Rd | 4 ++++ man/read.pxp.Rd | 4 ++++ man/tsp.igorwave.Rd | 2 +- 19 files changed, 66 insertions(+), 27 deletions(-) diff --git a/R/ReadIgorBinary.R b/R/ReadIgorBinary.R index 4ee1dd3..6c64a31 100644 --- 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 index 1925dd1..6037879 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -52,7 +52,7 @@ IgorR - 0.8.1 + 0.8.2 diff --git a/docs/index.html b/docs/index.html index 9a2ca5f..415cb2b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -35,7 +35,7 @@ IgorR - 0.8.1 + 0.8.2 diff --git a/docs/reference/IgorR-package.html b/docs/reference/IgorR-package.html index 663ab2e..a2b480e 100644 --- a/docs/reference/IgorR-package.html +++ b/docs/reference/IgorR-package.html @@ -58,7 +58,7 @@ IgorR - 0.8.1 + 0.8.2 diff --git a/docs/reference/IgorR-private.html b/docs/reference/IgorR-private.html index ab70dab..1c470b4 100644 --- a/docs/reference/IgorR-private.html +++ b/docs/reference/IgorR-private.html @@ -55,7 +55,7 @@ IgorR - 0.8.1 + 0.8.2 diff --git a/docs/reference/ReadAllNclampLogTables.html b/docs/reference/ReadAllNclampLogTables.html index 9ff5918..072eb37 100644 --- a/docs/reference/ReadAllNclampLogTables.html +++ b/docs/reference/ReadAllNclampLogTables.html @@ -55,7 +55,7 @@ IgorR - 0.8.1 + 0.8.2 diff --git a/docs/reference/ReadNclampLogTable.html b/docs/reference/ReadNclampLogTable.html index f0bb64b..d99ba95 100644 --- a/docs/reference/ReadNclampLogTable.html +++ b/docs/reference/ReadNclampLogTable.html @@ -57,7 +57,7 @@ IgorR - 0.8.1 + 0.8.2 diff --git a/docs/reference/SummariseSweepFile.html b/docs/reference/SummariseSweepFile.html index 9f9d590..6e6bc80 100644 --- a/docs/reference/SummariseSweepFile.html +++ b/docs/reference/SummariseSweepFile.html @@ -55,7 +55,7 @@ IgorR - 0.8.1 + 0.8.2 diff --git a/docs/reference/SweepFilesToDataFrame.html b/docs/reference/SweepFilesToDataFrame.html index 71b9596..9e6cf10 100644 --- a/docs/reference/SweepFilesToDataFrame.html +++ b/docs/reference/SweepFilesToDataFrame.html @@ -56,7 +56,7 @@ IgorR - 0.8.1 + 0.8.2 diff --git a/docs/reference/UpdateSweepDataFrame.html b/docs/reference/UpdateSweepDataFrame.html index 7678664..e900214 100644 --- a/docs/reference/UpdateSweepDataFrame.html +++ b/docs/reference/UpdateSweepDataFrame.html @@ -55,7 +55,7 @@ IgorR - 0.8.1 + 0.8.2 diff --git a/docs/reference/WaveToTimeSeries.html b/docs/reference/WaveToTimeSeries.html index e64a08b..1871e83 100644 --- a/docs/reference/WaveToTimeSeries.html +++ b/docs/reference/WaveToTimeSeries.html @@ -27,7 +27,7 @@ - @@ -56,7 +56,7 @@ IgorR - 0.8.1 + 0.8.2 @@ -91,7 +91,7 @@

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 cbind.

@@ -113,7 +113,13 @@

Arg

Value

-

a time series or multi time series (ts, mts)

+

a time series or multi time series (ts, + mts)

+ +

See also

+ +

Other igor-io: read.ibw, + read.pxp

@@ -123,6 +129,8 @@

Contents

  • Arguments
  • Value
    • + +
  • See also

    • Author

    diff --git a/docs/reference/index.html b/docs/reference/index.html index b78cde1..06e6356 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -52,7 +52,7 @@ IgorR - 0.8.1 + 0.8.2 diff --git a/docs/reference/read.ibw.html b/docs/reference/read.ibw.html index ae74186..19b9cba 100644 --- a/docs/reference/read.ibw.html +++ b/docs/reference/read.ibw.html @@ -55,7 +55,7 @@ IgorR - 0.8.1 + 0.8.2 @@ -131,6 +131,11 @@

    Value

    returns the name of a new R vector containing the data which has been made in the user environment

    +

    See also

    + +

    Other igor-io: WaveToTimeSeries, + read.pxp

    +

    Examples

    # return a list containing the wave
@@ -146,6 +151,8 @@ 
    Contents
    
       
  • Arguments
    • 
       
       
  • Value
    • 
+
+      
  • See also
    • 
       
       
  • Examples
    • 
     
diff --git a/docs/reference/read.pxp.html b/docs/reference/read.pxp.html
index 70179eb..cc0f57b 100644
--- a/docs/reference/read.pxp.html
+++ b/docs/reference/read.pxp.html
@@ -58,7 +58,7 @@
       
       
         IgorR
-        0.8.1
+        0.8.2
       
     
    
 
@@ -159,6 +159,11 @@ 
    Details
 available. Since this is information straight from the horse's mouth it will
 override the IgorPlatform argument.
    
     
+    
    See also
    
+
+    
    Other igor-io: WaveToTimeSeries,
+  read.ibw
    
+    
 
     
    Examples
    
     
    r=read.pxp(system.file("igor","testexpt.pxp",package="IgorR"))
    
@@ -171,6 +176,8 @@ 
    Contents
    
       
  • Value
    • 
 
       
  • Details
    • 
+
+      
  • See also
    • 
       
       
  • Examples
    • 
     
diff --git a/docs/reference/tsp.igorwave.html b/docs/reference/tsp.igorwave.html
index 5641814..0069df3 100644
--- a/docs/reference/tsp.igorwave.html
+++ b/docs/reference/tsp.igorwave.html
@@ -55,7 +55,7 @@
       
       
         IgorR
-        0.8.1
+        0.8.2
       
     
 
@@ -110,7 +110,7 @@ 
    Value
    
     
     
    See also
    
 
-    
    tsp
    
+    
    tsp
    
     
 
   
diff --git a/man/WaveToTimeSeries.Rd b/man/WaveToTimeSeries.Rd
index d5a3d7b..3feb9e1 100644
--- a/man/WaveToTimeSeries.Rd
+++ b/man/WaveToTimeSeries.Rd
@@ -13,12 +13,17 @@ WaveToTimeSeries(WaveData, ReturnOriginalDataOnError = TRUE)
 return original data (default TRUE)}
 }
 \value{
-a time series or multi time series (\code{ts}, \code{mts})
+a time series or multi time series (\code{\link[stats]{ts}},
+  \code{mts})
 }
 \description{
-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}.
 }
+\seealso{
+Other igor-io: \code{\link{read.ibw}},
+  \code{\link{read.pxp}}
+}
 \author{
 jefferis
 }
diff --git a/man/read.ibw.Rd b/man/read.ibw.Rd
index 0bf5f1d..fb1d5d2 100644
--- a/man/read.ibw.Rd
+++ b/man/read.ibw.Rd
@@ -39,6 +39,10 @@ sum(wavedata)
 wavename=read.ibw(system.file("igor","version5.ibw",package="IgorR"),MakeWave=TRUE) 
 sum(get(wavename))
 }
+\seealso{
+Other igor-io: \code{\link{WaveToTimeSeries}},
+  \code{\link{read.pxp}}
+}
 \author{
 jefferis
 }
diff --git a/man/read.pxp.Rd b/man/read.pxp.Rd
index b2d6190..5e0c120 100644
--- a/man/read.pxp.Rd
+++ b/man/read.pxp.Rd
@@ -51,6 +51,10 @@ override the \code{IgorPlatform} argument.
 \examples{
 r=read.pxp(system.file("igor","testexpt.pxp",package="IgorR"))
 }
+\seealso{
+Other igor-io: \code{\link{WaveToTimeSeries}},
+  \code{\link{read.ibw}}
+}
 \author{
 jefferis
 }
diff --git a/man/tsp.igorwave.Rd b/man/tsp.igorwave.Rd
index a5f4546..59f6ace 100644
--- a/man/tsp.igorwave.Rd
+++ b/man/tsp.igorwave.Rd
@@ -16,7 +16,7 @@ numeric vector with elements start, end, frequency
 Note that end = (npts-1) * deltat
 }
 \seealso{
-\code{\link{tsp}}
+\code{\link[stats]{tsp}}
 }
 \author{
 jefferis