1. CoGAPS
  2. man
  3. CoGapsFromCheckpoint.Rd
Browse code

added params and results class to R

Tom Sherman authored on 27/06/2018 17:29:43
Showing1 changed files
man/CoGapsFromCheckpoint.Rd
History View file @e2e488bf6
1 1 
deleted file mode 100644
... ... 
@@ -1,36 +0,0 @@
1 
-% Generated by roxygen2: do not edit by hand
2 
-% Please edit documentation in R/CoGAPS.R
3 
-\name{CoGapsFromCheckpoint}
4 
-\alias{CoGapsFromCheckpoint}
5 
-\title{Restart CoGAPS from Checkpoint File}
6 
-\usage{
7 
-CoGapsFromCheckpoint(D, S, nFactor, nIter, checkpointFile)
8 
-}
9 
-\arguments{
10 
-\item{D}{data matrix}
11 
-
12 
-\item{S}{uncertainty matrix}
13 
-
14 
-\item{nFactor}{number of patterns}
15 
-
16 
-\item{nIter}{number of iterations}
17 
-
18 
-\item{checkpointFile}{path to checkpoint file}
19 
-
20 
-\item{path}{path to checkpoint file}
21 
-}
22 
-\value{
23 
-list with A and P matrix estimates
24 
-}
25 
-\description{
26 
-Restart CoGAPS from Checkpoint File
27 
-}
28 
-\details{
29 
-loads the state of a previous CoGAPS run from a file and
30 
- continues the run from that point
31 
-}
32 
-\examples{
33 
-data(SimpSim)
34 
-result <- CoGAPS(SimpSim.D, SimpSim.S, nFactor=3, nOutputs=250)
35 
-}
36 
-
Browse code

added back PUMP and FixedPatterns option

Tom Sherman authored on 13/06/2018 21:35:14
Showing1 changed files
man/CoGapsFromCheckpoint.Rd
History View file @dd3a94412
... ... 
@@ -4,16 +4,20 @@
4 4 
 \alias{CoGapsFromCheckpoint}
5 5 
 \title{Restart CoGAPS from Checkpoint File}
6 6 
 \usage{
7 
-CoGapsFromCheckpoint(D, S, path, checkpointFile = NA)
7 
+CoGapsFromCheckpoint(D, S, nFactor, nIter, checkpointFile)
8 8 
 }
9 9 
 \arguments{
10 10 
 \item{D}{data matrix}
11 11
12 12 
 \item{S}{uncertainty matrix}
13 13
14 
-\item{path}{path to checkpoint file}
14 
+\item{nFactor}{number of patterns}
15 
+
16 
+\item{nIter}{number of iterations}
17 
+
18 
+\item{checkpointFile}{path to checkpoint file}
15 19
16 
-\item{checkpointFile}{name for future checkpooints made}
20 
+\item{path}{path to checkpoint file}
17 21 
 }
18 22 
 \value{
19 23 
 list with A and P matrix estimates
... ... 
@@ -25,4 +29,8 @@ Restart CoGAPS from Checkpoint File
25 29 
 loads the state of a previous CoGAPS run from a file and
26 30 
  continues the run from that point
27 31 
 }
32 
+\examples{
33 
+data(SimpSim)
34 
+result <- CoGAPS(SimpSim.D, SimpSim.S, nFactor=3, nOutputs=250)
35 
+}
28 36
Browse code

added back docs; fixed RNG syntax

Tom Sherman authored on 31/05/2018 21:34:33
Showing1 changed files
man/CoGapsFromCheckpoint.Rd
History View file @47a10bdce
1 1 
new file mode 100644
... ... 
@@ -0,0 +1,28 @@
1 
+% Generated by roxygen2: do not edit by hand
2 
+% Please edit documentation in R/CoGAPS.R
3 
+\name{CoGapsFromCheckpoint}
4 
+\alias{CoGapsFromCheckpoint}
5 
+\title{Restart CoGAPS from Checkpoint File}
6 
+\usage{
7 
+CoGapsFromCheckpoint(D, S, path, checkpointFile = NA)
8 
+}
9 
+\arguments{
10 
+\item{D}{data matrix}
11 
+
12 
+\item{S}{uncertainty matrix}
13 
+
14 
+\item{path}{path to checkpoint file}
15 
+
16 
+\item{checkpointFile}{name for future checkpooints made}
17 
+}
18 
+\value{
19 
+list with A and P matrix estimates
20 
+}
21 
+\description{
22 
+Restart CoGAPS from Checkpoint File
23 
+}
24 
+\details{
25 
+loads the state of a previous CoGAPS run from a file and
26 
+ continues the run from that point
27 
+}
28 
+
Browse code

make lintr happy

Tom Sherman authored on 31/05/2018 21:28:52
Showing1 changed files
man/CoGapsFromCheckpoint.Rd
History View file @743777199
1 1 
deleted file mode 100644
... ... 
@@ -1,28 +0,0 @@
1 
-% Generated by roxygen2: do not edit by hand
2 
-% Please edit documentation in R/CoGAPS.R
3 
-\name{CoGapsFromCheckpoint}
4 
-\alias{CoGapsFromCheckpoint}
5 
-\title{Restart CoGAPS from Checkpoint File}
6 
-\usage{
7 
-CoGapsFromCheckpoint(D, S, path, checkpointFile = NA)
8 
-}
9 
-\arguments{
10 
-\item{D}{data matrix}
11 
-
12 
-\item{S}{uncertainty matrix}
13 
-
14 
-\item{path}{path to checkpoint file}
15 
-
16 
-\item{checkpointFile}{name for future checkpooints made}
17 
-}
18 
-\value{
19 
-list with A and P matrix estimates
20 
-}
21 
-\description{
22 
-Restart CoGAPS from Checkpoint File
23 
-}
24 
-\details{
25 
-loads the state of a previous CoGAPS run from a file and
26 
- continues the run from that point
27 
-}
28 
-
Browse code

passing checks

sherman5 authored on 07/02/2018 18:08:11
Showing1 changed files
man/CoGapsFromCheckpoint.Rd
History View file @afdd7d637
... ... 
@@ -12,6 +12,8 @@ CoGapsFromCheckpoint(D, S, path, checkpointFile = NA)
12 12 
 \item{S}{uncertainty matrix}
13 13
14 14 
 \item{path}{path to checkpoint file}
15 
+
16 
+\item{checkpointFile}{name for future checkpooints made}
15 17 
 }
16 18 
 \value{
17 19 
 list with A and P matrix estimates
Browse code

parallel checkpoints tenatively working - still need formal testing

sherman5 authored on 30/01/2018 21:33:47
Showing1 changed files
man/CoGapsFromCheckpoint.Rd
History View file @4d1dde823
... ... 
@@ -4,7 +4,7 @@
4 4 
 \alias{CoGapsFromCheckpoint}
5 5 
 \title{Restart CoGAPS from Checkpoint File}
6 6 
 \usage{
7 
-CoGapsFromCheckpoint(D, S, path, checkpointFile = "gaps_checkpoint.out")
7 
+CoGapsFromCheckpoint(D, S, path, checkpointFile = NA)
8 8 
 }
9 9 
 \arguments{
10 10 
 \item{D}{data matrix}
Browse code

parallel checkpoints mostly working - some bugs with processing output

sherman5 authored on 30/01/2018 20:50:37
Showing1 changed files
man/CoGapsFromCheckpoint.Rd
History View file @d9e7e41cb
... ... 
@@ -4,7 +4,7 @@
4 4 
 \alias{CoGapsFromCheckpoint}
5 5 
 \title{Restart CoGAPS from Checkpoint File}
6 6 
 \usage{
7 
-CoGapsFromCheckpoint(D, S, path)
7 
+CoGapsFromCheckpoint(D, S, path, checkpointFile = "gaps_checkpoint.out")
8 8 
 }
9 9 
 \arguments{
10 10 
 \item{D}{data matrix}
Browse code

cleaning up notes for v3

sherman5 authored on 24/01/2018 23:38:02
Showing1 changed files
man/CoGapsFromCheckpoint.Rd
History View file @536217d8d
1 1 
new file mode 100644
... ... 
@@ -0,0 +1,26 @@
1 
+% Generated by roxygen2: do not edit by hand
2 
+% Please edit documentation in R/CoGAPS.R
3 
+\name{CoGapsFromCheckpoint}
4 
+\alias{CoGapsFromCheckpoint}
5 
+\title{Restart CoGAPS from Checkpoint File}
6 
+\usage{
7 
+CoGapsFromCheckpoint(D, S, path)
8 
+}
9 
+\arguments{
10 
+\item{D}{data matrix}
11 
+
12 
+\item{S}{uncertainty matrix}
13 
+
14 
+\item{path}{path to checkpoint file}
15 
+}
16 
+\value{
17 
+list with A and P matrix estimates
18 
+}
19 
+\description{
20 
+Restart CoGAPS from Checkpoint File
21 
+}
22 
+\details{
23 
+loads the state of a previous CoGAPS run from a file and
24 
+ continues the run from that point
25 
+}
26 
+