diff --git a/DESCRIPTION b/DESCRIPTION index d733e042..f3411680 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -82,4 +82,4 @@ Suggests: Encoding: UTF-8 Language: en-GB Config/testthat/edition: 3 -Config/roxygen2/version: 8.1.0 +Config/roxygen2/version: 8.1.1 diff --git a/docs/404.html b/docs/404.html index 17940f30..1ad5f6a8 100644 --- a/docs/404.html +++ b/docs/404.html @@ -20,7 +20,7 @@ dsBase - 6.3.6.9000 + 7.0.0.9000 + + + + + +
+
+
+ + +
+

Instructions & checklist for PR author

+
+

Description of changes

+

[Add descriptions of changes made]

+
+
+

Refactor instructions

+
  • +
  • +
+
+

Testing instructions

+
  • +
  • +
  • +
  • +
+
+
+

Instructions & checklist for PR reviewers

+
  • +
  • +
  • +
+ + +
+ + +
+ + + + + + + diff --git a/docs/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..35a1ccdf --- /dev/null +++ b/docs/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,38 @@ +# NA + +## Instructions & checklist for PR author + +### Description of changes + +\[Add descriptions of changes made\] + +### Refactor instructions + +Replaced `x <- eval(parse(text = x.name), envir = parent.frame())` with +`x <- .loadServersideObject(x)` + +If necessary, check the class of the object using `.checkClass()` + +### Testing instructions + +Writen server-side unit tests for unhappy flow + +Run `devtools::test(filter = "smk-|disc|arg")` and check it passes + +Run `devtools::check(args = '--no-tests')` and check it passes (we run +tests separately to skip performance checks) + +Run +[`devtools::build()`](https://devtools.r-lib.org/reference/build.html) +and check it builds without errors + +## Instructions & checklist for PR reviewers + +Run `devtools::test(filter = "smk-|disc|arg")` and check it passes + +Run `devtools::check(args = '--no-tests')` and check it passes (we run +tests separately to skip performance checks) + +Run +[`devtools::build()`](https://devtools.r-lib.org/reference/build.html) +and check it builds without errors diff --git a/docs/authors.html b/docs/authors.html index dc47fb0e..26299dab 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -7,7 +7,7 @@ dsBase - 6.3.6.9000 + 7.0.0.9000 + + + + + +
+
+
+ +
+

This function is similar to R function exp.

+
+ +
+

Usage

+
expDS(x)
+
+ +
+

Arguments

+ + +
x
+

a string character, the name of a numeric or integer vector

+ +
+
+

Value

+

the object specified by the newobj argument +of ds.exp (or default name exp.newobj) +which is written to the serverside. The output object is of class numeric.

+
+
+

Details

+

The function computes the exponential values of an input numeric +or integer vector.

+
+
+

Author

+

DataSHIELD Development Team

+

Tim Cadman, Genomics Coordination Centre, UMCG, Netherlands

+
+ +
+ + +
+ + + +
+ + + + + + + diff --git a/docs/reference/expDS.md b/docs/reference/expDS.md new file mode 100644 index 00000000..ae216f74 --- /dev/null +++ b/docs/reference/expDS.md @@ -0,0 +1,32 @@ +# Computes the exponential values of the input variable + +This function is similar to R function `exp`. + +## Usage + +``` r +expDS(x) +``` + +## Arguments + +- x: + + a string character, the name of a numeric or integer vector + +## Value + +the object specified by the `newobj` argument of `ds.exp` (or default +name `exp.newobj`) which is written to the serverside. The output object +is of class numeric. + +## Details + +The function computes the exponential values of an input numeric or +integer vector. + +## Author + +DataSHIELD Development Team + +Tim Cadman, Genomics Coordination Centre, UMCG, Netherlands diff --git a/docs/reference/extractQuantilesDS1.html b/docs/reference/extractQuantilesDS1.html index 757856e3..8d6107dc 100644 --- a/docs/reference/extractQuantilesDS1.html +++ b/docs/reference/extractQuantilesDS1.html @@ -9,7 +9,7 @@ dsBase - 6.3.6.9000 + 7.0.0.9000
+ + + + + +
+
+
+ +
+

This function is similar to R function log.

+
+ +
+

Usage

+
logDS(x, base = exp(1))
+
+ +
+

Arguments

+ + +
x
+

a string character, the name of a numeric or integer vector

+ + +
base
+

a positive number, the base for which logarithms are computed. +Default exp(1).

+ +
+
+

Value

+

the object specified by the newobj argument +of ds.log (or default name log.newobj) +which is written to the serverside. The output object is of class numeric.

+
+
+

Details

+

The function computes the logarithm values of an input numeric +or integer vector. By default natural logarithms are computed.

+
+
+

Author

+

DataSHIELD Development Team

+

Tim Cadman, Genomics Coordination Centre, UMCG, Netherlands

+
+ +
+ + +
+ + + + + + + diff --git a/docs/reference/logDS.md b/docs/reference/logDS.md new file mode 100644 index 00000000..570e548a --- /dev/null +++ b/docs/reference/logDS.md @@ -0,0 +1,37 @@ +# Computes the logarithm values of the input variable + +This function is similar to R function `log`. + +## Usage + +``` r +logDS(x, base = exp(1)) +``` + +## Arguments + +- x: + + a string character, the name of a numeric or integer vector + +- base: + + a positive number, the base for which logarithms are computed. Default + `exp(1)`. + +## Value + +the object specified by the `newobj` argument of `ds.log` (or default +name `log.newobj`) which is written to the serverside. The output object +is of class numeric. + +## Details + +The function computes the logarithm values of an input numeric or +integer vector. By default natural logarithms are computed. + +## Author + +DataSHIELD Development Team + +Tim Cadman, Genomics Coordination Centre, UMCG, Netherlands diff --git a/docs/reference/lsDS.html b/docs/reference/lsDS.html index 8fdea6b9..04957006 100644 --- a/docs/reference/lsDS.html +++ b/docs/reference/lsDS.html @@ -9,7 +9,7 @@ dsBase - 6.3.6.9000 + 7.0.0.9000