Merge pull request #338 from davraam/v6.3.1-dev

update unListDS help file

Author: davraam

R/unListDS.R

@@ -1,28 +1,29 @@
-#' @title unListDS a serverside assign function called by ds.unList
-#' @description this function is based on the native R function {unlist}
+#' 
+#' @title \code{unListDS} a serverside assign function called by \code{ds.unList}
+#' @description this function is based on the native R function \code{unlist}
 #' which coerces an object of list class back to the class it was when
 #' it was coerced into a list
-#' @details See details of the native R function {unlist}.
+#' @details See details of the native R function \code{unlist}.
 #' This function represents a substantive restructuring of an earlier version
 #' created by Amadou Gaye. For further details of its working please
-#' see 'details' in the help for {ds.unList}.
+#' see 'details' in the help for \code{ds.unList}.
 #' @param x.name the name of the input object to be unlisted.
 #' It must be specified in inverted commas e.g. x.name="input.object.name". Fully
-#' specified by the <x.name> argument of {ds.unList}
-#' @return the object specified by the <newobj> argument of the 
-#' {ds.unList} function (or by default <x.name>.unlist
-#' if the <newobj> argument is NULL). This is written to the serverside.
-#' As well as writing the output object as <newobj>
+#' specified by the \code{x.name} argument of \code{ds.unList}
+#' @return the object specified by the \code{newobj} argument of the 
+#' \code{ds.unList} function (or by default "unlist.newobj"
+#' if the \code{newobj} argument is NULL). This is written to the serverside.
+#' As well as writing the output object as \code{newobj}
 #' on the serverside, two validity messages are returned
-#' indicating whether <newobj> has been created in each data source and if so whether
+#' indicating whether \code{newobj} has been created in each data source and if so whether
 #' it is in a valid form. If its form is not valid in at least one study - e.g. because
 #' a disclosure trap was tripped and creation of the full output object was blocked -
-#' {ds.seq()} also returns any studysideMessages that can explain the error in creating
+#' \code{ds.seq} also returns any studysideMessages that can explain the error in creating
 #' the full output object. As well as appearing on the screen at run time,if you wish to
-#' see the relevant studysideMessages at a later date you can use the {ds.message}
+#' see the relevant studysideMessages at a later date you can use the \code{ds.message}
 #' function. If you type ds.message("<newobj>") it will print out the relevant
-#' studysideMessage from any datasource in which there was an error in creating <newobj>
-#' and a studysideMessage was saved. Because the outcome object from ds.unList is
+#' studysideMessage from any datasource in which there was an error in creating \code{newobj}
+#' and a studysideMessage was saved. Because the outcome object from \code{ds.unList} is
 #' typically a list object with no names, if there are no errors in creating it
 #' the message returned from ds.message("<newobj>") in each study will read
 #' "Outcome object is a list without names. So a studysideMessage may be hidden.
@@ -31,6 +32,7 @@
 #' the nature of the output from a call to ds.unList - e.g. ds.class, ds.length etc
 #' @author Amadou Gaye (2016), Paul Burton (19/09/2019) for DataSHIELD Development Team
 #' @export
+#' 
 unListDS <- function(x.name) {
 
     if (is.character(x.name)) {

R/varDS.R

@@ -5,7 +5,7 @@
 #' a missing value is returned.
 #' @param xvect a vector
 #' @return a list, with the sum of the input variable, the sum of squares of the input variable,
-#' the number of missing values, the number of valid values, the number of total lenght of the
+#' the number of missing values, the number of valid values, the number of total length of the
 #' variable, and a study message indicating whether the number of valid is less than the
 #' disclosure threshold
 #' @author Amadou Gaye, Demetris Avraam, for DataSHIELD Development Team