Skip to content

Commit cce265c

Browse files
committed
docs: updated docs with authorship and parameters
1 parent 4b751b1 commit cce265c

7 files changed

Lines changed: 46 additions & 27 deletions

File tree

R/cDS.R

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,29 @@
33
#' @description This function is similar to the R base function 'c'.
44
#' @details Unlike the R base function 'c' on vector or list of certain
55
#' length are allowed as output
6-
#' @param objs a list which contains the the objects to concatenate.
6+
#' @param x.names a character vector of object names to concatenate.
77
#' @return a vector or list
88
#' @author Gaye, A.
9+
#' @author Tim Cadman, Genomics Coordination Centre, UMCG, Netherlands
910
#' @export
10-
#'
11-
cDS <- function (objs) {
12-
11+
#'
12+
cDS <- function (x.names) {
13+
1314
# Check Permissive Privacy Control Level.
1415
dsBase::checkPermissivePrivacyControlLevel(c('permissive', 'avocado'))
15-
16-
# this filter sets the minimum number of observations that are allowed
16+
17+
# this filter sets the minimum number of observations that are allowed
1718

1819
#############################################################
1920
# MODULE 1: CAPTURE THE nfilter SETTINGS
2021
thr <- dsBase::listDisclosureSettingsDS()
2122
nfilter.tab <- as.numeric(thr$nfilter.tab)
22-
#nfilter.glm <- as.numeric(thr$nfilter.glm)
23-
#nfilter.subset <- as.numeric(thr$nfilter.subset)
24-
#nfilter.string <- as.numeric(thr$nfilter.string)
2523
#############################################################
26-
24+
25+
objs <- list()
26+
for (i in seq_along(x.names)) {
27+
objs[[i]] <- .loadServersideObject(x.names[i])
28+
}
2729
x <- unlist(objs)
2830

2931
# check if the output is valid and output accordingly

R/lengthDS.R

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
#'
23
#' @title Returns the length of a vector or list
34
#' @description This function is similar to R function \code{length}.

R/listDS.R

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,21 @@
33
#' @description this function is similar to R function 'list'
44
#' @details Unlike the R function 'list' it takes also a vector of characters,
55
#' the names of the elements in the output list.
6-
#' @param input a list of objects to coerce into a list
7-
#' @param eltnames a character list, the names of the elements in the list.
6+
#' @param x.names a character vector of object names to coerce into a list.
7+
#' @param eltnames a character vector, the names of the elements in the list.
88
#' @return a list
99
#' @author Gaye, A.
10+
#' @author Tim Cadman, Genomics Coordination Centre, UMCG, Netherlands
1011
#' @export
11-
#'
12-
listDS <-function (input=NULL, eltnames=NULL){
13-
14-
mylist <- input
12+
#'
13+
listDS <-function (x.names=NULL, eltnames=NULL){
14+
15+
mylist <- list()
16+
for (i in seq_along(x.names)) {
17+
mylist[[i]] <- .loadServersideObject(x.names[i])
18+
}
1519
names(mylist) <- unlist(eltnames)
1620

1721
return(mylist)
18-
22+
1923
}

man/cDS.Rd

Lines changed: 4 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/lengthDS.Rd

Lines changed: 5 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/listDS.Rd

Lines changed: 5 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/numNaDS.Rd

Lines changed: 8 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)