documentation fixes

GeoBosh · Apr 12, 2021 · 20087b5 · 20087b5
1 parent dafb420
commit 20087b5
Show file tree

Hide file tree

Showing 8 changed files with 34 additions and 36 deletions.
diff --git a/docs/articles/pcts_data.html b/docs/articles/pcts_data.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -3,5 +3,5 @@ pkgdown: 1.5.1
 pkgdown_sha: ~
 articles:
   pcts_data: pcts_data.html
-last_built: 2021-04-11T12:03Z
+last_built: 2021-04-12T22:14Z
 
diff --git a/docs/reference/PeriodicMTS-class.html b/docs/reference/PeriodicMTS-class.html
diff --git a/docs/reference/availStart.html b/docs/reference/availStart.html
diff --git a/man/PeriodicAutocorrelations-class.Rd b/man/PeriodicAutocorrelations-class.Rd
@@ -2,7 +2,7 @@
 \Rdversion{1.1}
 \docType{class}
 \alias{PeriodicAutocorrelations-class}
-%\alias{plot,PeriodicAutocorrelations,missing-method}
+\alias{plot,PeriodicAutocorrelations,missing-method}
 
 \title{Class PeriodicAutocorrelations}
 \description{Class PeriodicAutocorrelations.}

diff --git a/man/PeriodicMTS-class.Rd b/man/PeriodicMTS-class.Rd
@@ -2,6 +2,7 @@
 \Rdversion{1.1}
 \docType{class}
 \alias{PeriodicMTS-class}
+\alias{plot,PeriodicMTS,missing-method}
 
 \title{Class \code{"PeriodicMTS"}}
 \description{
@@ -51,7 +52,14 @@ Class \code{"\linkS4class{vector}"}, by class "matrix", distance 4, with explici
     \item{plot}{\code{signature(x = "PeriodicMTS", y = "missing")}: ... }
     \item{show}{\code{signature(object = "PeriodicMTS")}: ... }
     \item{summary}{\code{signature(object = "PeriodicMTS")}: ... }
-  }
+
+    \item{[}{\code{signature(x = "PeriodicMTS", i = "ANY", j = "ANY", drop = "ANY")}: ... }
+    \item{[}{\code{signature(x = "PeriodicMTS", i = "AnyDateTime", j = "ANY", drop = "ANY")}: ... }
+    \item{[}{\code{signature(x = "PeriodicMTS", i = "AnyDateTime", j = "missing", drop = "ANY")}: ... }
+    \item{[[}{\code{signature(x = "PeriodicMTS", i = "ANY", j = "ANY")}: ... }
+    \item{fitPM}{\code{signature(model = "PeriodicArModel", x = "PeriodicMTS")}: ... }
+    \item{pcApply}{\code{signature(object = "PeriodicMTS")}: ... }
+    \item{pcMean}{\code{signature(object = "PeriodicMTS")}: ... }}
 }
 %\references{
 %%%  ~~put references to the literature/web site here~~

diff --git a/man/availStart.Rd b/man/availStart.Rd
@@ -27,7 +27,7 @@ availEnd(x, any = TRUE)
   Argument \code{any} is meaningful only for multivariate objects.  Its
   name is short for
   "the first/last index for which any of the values (ie at least one) is non-\code{NA}".
-  \code{any = FALSE} is taken to mean that the inedx is the first/last
+  \code{any = FALSE} is taken to mean that the index is the first/last
   for which all values are non-\code{NA}.
 
 

diff --git a/vignettes/pcts_data.Rmd b/vignettes/pcts_data.Rmd
@@ -50,8 +50,7 @@ ap
 
 Get the data from Mar 1952 to Feb 1959:
 ```{r}
-window(ap, start = c(1952, 3))
-window(ap, end = c(1959, 2))
+window(ap, start = c(1952, 3), end = c(1959, 2))
 ```
 
 Take the summer months only:
@@ -60,12 +59,15 @@ window(ap, seasons = 7:9)
 ```
 
 
-The dataset `dataFranses1996` contains a multivariate quarterly time series. See `?dataFranses1996` for more information. Here are some excerpts from it:
+The dataset `dataFranses1996` contains a multivariate quarterly time series, see
+`?dataFranses1996` for more information. The object has the standard R class `"mts"`, so can
+be loaded using `data()` without loading `pcts`.
+Here is some information about it:
 ```{r}
 data(dataFranses1996)
 class(dataFranses1996)
-colnames(dataFranses1996)
 dim(dataFranses1996) # c(148, 19)
+colnames(dataFranses1996)
 ```
 
 It can be converted to periodic time series with
@@ -84,7 +86,7 @@ tipi <- dataFranses1996[ , "USTotalIPI"]
 plot(tipi)
 ```
 
-Convert `tipi` to PeriodicTS and remove NA's at the start and end
+Convert `tipi` to `PeriodicTS` and remove `NA`s at the start and end:
 ```{r}
 pctipi <- pcts(tipi)
 pctipi <- window(pctipi, start = availStart(pctipi), end = availEnd(pctipi))