[Pomp-commits] r353 - pkg/man

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

Author: kingaa
Date: 2010-09-30 03:50:11 +0200 (Thu, 30 Sep 2010)
New Revision: 353

Modified:
   pkg/man/basic-probes.Rd
Log:

- update the man page to include 'probe.ccf'


Modified: pkg/man/basic-probes.Rd
===================================================================
--- pkg/man/basic-probes.Rd	2010-09-29 22:05:47 UTC (rev 352)
+++ pkg/man/basic-probes.Rd	2010-09-30 01:50:11 UTC (rev 353)
@@ -9,6 +9,7 @@
 \alias{probe.cov}
 \alias{probe.cor}
 \alias{probe.acf}
+\alias{probe.ccf}
 \alias{probe.marginal}
 \alias{probe.nlar}
 \title{Some probes for partially-observed Markov processes}
@@ -25,6 +26,7 @@
 probe.nlar(var, lags, powers, transform = identity)
 probe.acf(var, lag.max, type = c("covariance", "correlation"),
           transform = identity)
+probe.ccf(vars, lags, transform = identity)
 probe.cov(vars, lag, method = c("pearson", "kendall", "spearman"),
                  transform = identity)
 probe.cor(vars, lag, method = c("pearson", "kendall", "spearman"),
@@ -33,7 +35,7 @@
 probe.quantile(var, prob, transform = identity)
 }
 \arguments{
-  \item{var}{
+  \item{var, vars}{
     character; the name(s) of the observed variable(s).
   }
   \item{trim}{
@@ -55,16 +57,15 @@
   \item{lag.max}{
     The maximum lag at which the ACF is computed.
   }
-  \item{lag}{
+  \item{lag, lags}{
     In \code{probe.cov} and \code{probe.cor}, the lag between time series.
+    In \code{probe.ccf}, a vector of lags between time series.
+    Positive lags correspond to \code{x} advanced relative to \code{y};
+    negative lags, to the reverse.
   }
   \item{type}{
     Compute autocorrelation or autocovariance?
   }
-  \item{vars}{
-    length-2 character vector;
-    the names or indices of the observed variables between which covariance or correlation is to be computed.
-  }
   \item{method}{
     The type of covariance or correlation to compute: see \code{\link{cov}} and \code{\link{cor}}.
   }