1. structToolbox
  2. man
  3. model_reverse.Rd
Browse code

update documentation, namespace and description

using roxygen

Gavin Rhys Lloyd authored on 06/03/2020 12:03:43
Showing 1 changed files
man/model_reverse.Rd
History View file @ 8c01dfa
... ... 
@@ -1,10 +1,14 @@
1 1 
 % Generated by roxygen2: do not edit by hand
2 
-% Please edit documentation in R/mean_centre_class.R, R/model_reverse_doc.R
3 
-\name{model_reverse,mean_centre,DatasetExperiment-method}
2 
+% Please edit documentation in R/autoscale_class.R, R/mean_centre_class.R,
3 
+%   R/model_reverse_doc.R
4 
+\name{model_reverse,autoscale,DatasetExperiment-method}
5 
+\alias{model_reverse,autoscale,DatasetExperiment-method}
4 6 
 \alias{model_reverse,mean_centre,DatasetExperiment-method}
5 7 
 \alias{model_reverse}
6 8 
 \title{Reverse preprocessing}
7 9 
 \usage{
10 
+\S4method{model_reverse}{autoscale,DatasetExperiment}(M, D)
11 
+
8 12 
 \S4method{model_reverse}{mean_centre,DatasetExperiment}(M, D)
9 13 
 }
10 14 
 \arguments{
Browse code

update to use new struct class constructors

Gavin Rhys Lloyd authored on 06/02/2020 13:51:52
Showing 1 changed files
man/model_reverse.Rd
History View file @ a110b7e
... ... 
@@ -11,8 +11,6 @@
11 11 
 \item{M}{a model object}
12 12
13 13 
 \item{D}{a DatasetExperiment object}
14 
-
15 
-\item{...}{additional slots and values passed to struct_class}
16 14 
 }
17 15 
 \value{
18 16 
 Returns a modified DatasetExperiment object
Browse code

incremental changes to use struct class constructors

Gavin Rhys Lloyd authored on 04/02/2020 17:18:11
Showing 1 changed files
man/model_reverse.Rd
History View file @ 9bf1542
... ... 
@@ -12,7 +12,7 @@
12 12
13 13 
 \item{D}{a DatasetExperiment object}
14 14
15 
-\item{...}{slots and values for the new object}
15 
+\item{...}{additional slots and values passed to struct_class}
16 16 
 }
17 17 
 \value{
18 18 
 Returns a modified DatasetExperiment object
Browse code

fix broken tests and...

...update some documentation

Gavin Rhys Lloyd authored on 17/12/2019 17:24:38
Showing 1 changed files
man/model_reverse.Rd
History View file @ 56a019f
... ... 
@@ -11,6 +11,8 @@
11 11 
 \item{M}{a model object}
12 12
13 13 
 \item{D}{a DatasetExperiment object}
14 
+
15 
+\item{...}{slots and values for the new object}
14 16 
 }
15 17 
 \value{
16 18 
 Returns a modified DatasetExperiment object
Browse code

use class contructors and...

...rename all function with dot to underscore
replace dataset with DatasetExperiment

Gavin Rhys Lloyd authored on 17/12/2019 15:48:01
Showing 1 changed files
man/model_reverse.Rd
History View file @ 8db793a
1 1 
new file mode 100644
... ... 
@@ -0,0 +1,24 @@
1 
+% Generated by roxygen2: do not edit by hand
2 
+% Please edit documentation in R/mean_centre_class.R, R/model_reverse_doc.R
3 
+\name{model_reverse,mean_centre,DatasetExperiment-method}
4 
+\alias{model_reverse,mean_centre,DatasetExperiment-method}
5 
+\alias{model_reverse}
6 
+\title{Reverse preprocessing}
7 
+\usage{
8 
+\S4method{model_reverse}{mean_centre,DatasetExperiment}(M, D)
9 
+}
10 
+\arguments{
11 
+\item{M}{a model object}
12 
+
13 
+\item{D}{a DatasetExperiment object}
14 
+}
15 
+\value{
16 
+Returns a modified DatasetExperiment object
17 
+}
18 
+\description{
19 
+Reverse the effect of a preprocessing step on a DatasetExperiment.
20 
+}
21 
+\examples{
22 
+M = example_model()
23 
+D = model_reverse(M,iris_DatasetExperiment())
24 
+}