Export uniquePresent

R/NMreadTabSlow.R

@@ -9,7 +9,8 @@
 ##'     slowly, and most often `NMreadTab` is a better function to
 ##'     use. However, `NMreadTabslow` also works for table files that
 ##'     contain incompatible tables.
-
+##' @keywords internal
+##' 
 ### Polishing needed. Don't export.
 
 NMreadTabSlow <- function(file){

R/uniquePresent.R

@@ -1,11 +1,30 @@
-
-uniquePresent <- function(x,req.n1=TRUE){
+##' Extract unique non-missing value from vector
+##'
+##' @param x A vector, either numeric or character.
+##' @param reg.n1 Require one unique value? If `TRUE` (default), an
+##'     error is thrown if non-unique values found. If `FALSE`, all
+##'     the unique values are returned.
+##' @param na.pattern In addition to NA-elements, what text strings
+##'     should be considered missing? Default is empty strings and
+##'     strings only containing white spaces (`na.pattern="^ *$"`).
+##' @details This function is particularly useful when combining data
+##'     sets of which only some contain certain
+##'     variables. `uniquePresent` with `req.n1=TRUE` makes sure the
+##'     result is a single unique value (e.g., within subjects). A
+##'     typical use is carrying subject-level covariates from one data
+##'     set to another in a longitudinal analysis. 
+##' @export
+uniquePresent <- function(x,req.n1=TRUE,na.pattern){
+    if(missing(na.regex)) na.pattern <- "^ *$"
+
     un.x <- unique(x)
-    un.x <- un.x[un.x!=""&!is.na(un.x)]
+    un.x <- un.x[!is.na(un.x) &  !grepl(pattern=na.pattern,un.x) ]
+
     if(length(un.x)==0) {
         warning("No value found")
         return(NA)
     }
     if(req.n1&&length(un.x)!=1) stop("Number of unique values is not 1.")
-    un.x
+
+    return(un.x)
 }

_pkgdown.yml

@@ -48,6 +48,7 @@ reference:
   - NMorderColumns
   - compareCols
   - listMissings
+  - uniquePresent
   - mergeCheck
   - renameByContents
   - flagsAssign
@@ -75,6 +76,7 @@ reference:
   - NMreadCsv
   - NMreadExt
   - NMreadPhi
+  - NMreadShk
   - NMreadTab
   - NMreadParsText
   - NMinfo

devel/todo.org

@@ -655,6 +655,7 @@ Not warning. Warning if standard variable?
 *** flagsAssign
 **** TODO [#A] flag.n should be factor
 And flagsCount should retain them
+Was this supposed to be flag.c?
 **** DONE flagsCount should not require a flag table
 **** DONE flagsCount should throw an error if not all flags are covered by provided flag table
 **** CANCELLED flagsAssign and flagsCount should not offer increasing option.