core_commons.R 12.3 KB
Newer Older
Holger Brandl's avatar
Holger Brandl committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
########################################################################################################################
## set a default cran r mirror  and customize environment

#cat(".Rprofile: Setting Goettingen repository\n")
r = getOption("repos") # hard code the UK repo for CRAN

r["CRAN"] = "http://ftp5.gwdg.de/pub/misc/cran/"
options(repos = r)
rm(r)


## user browser for help
options(help_type="html")

## plot more characters per line
options(width=150)

17
18
19
20
21
22
## adjust dplyr printing settings
## http://stackoverflow.com/questions/22471256/overriding-variables-not-shown-in-dplyr-to-display-all-columns-from-df
## http://stackoverflow.com/questions/29396111/dplyrtbl-df-fill-whole-screen
options(dplyr.print_max = 20) ## num rows
options(dplyr.width = 130) ## width

Holger Brandl's avatar
Holger Brandl committed
23
24
25
# for sqldf to avoid the use of tckl
options(gsubfn.engine = "R")

Holger Brandl's avatar
Holger Brandl committed
26

Holger Brandl's avatar
Holger Brandl committed
27
########################################################################################################################
Holger Brandl's avatar
Holger Brandl committed
28
## automatic package installation
Holger Brandl's avatar
Holger Brandl committed
29

30
require_auto <-  function(x){
31
32
    warning("require_auto is deprecated, use loadpack() instead")

Holger Brandl's avatar
Holger Brandl committed
33
34
35
36
37
    x <- as.character(substitute(x))

    if(isTRUE(x %in% .packages(all.available=TRUE))) {
        eval(parse(text=paste("require(", x, ",  quietly=T)", sep="")))
    } else {
38
        #        update.packages(ask=F) # update dependencies, if any.
Holger Brandl's avatar
Holger Brandl committed
39
40
41
42
43
44
45
        eval(parse(text=paste("install.packages('", x, "')", sep="")))
    }

    if(isTRUE(x %in% .packages(all.available=TRUE))) {
        eval(parse(text=paste("require(", x, ",  quietly=T)", sep="")))
    } else {
        source("http://bioconductor.org/biocLite.R")
46
        #        biocLite(character(), ask=FALSE) # update dependencies, if any.
47
        eval(parse(text=paste("biocLite('", x, "', ask=FALSE)", sep="")))
Holger Brandl's avatar
Holger Brandl committed
48
49
50
51
        eval(parse(text=paste("require(", x, ",  quietly=T)", sep="")))
    }
}

52

53
loadpack <-  function(x, warn_conflicts=T){
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
    x <- as.character(substitute(x));

    if(!isTRUE(x %in% .packages(all.available=TRUE)) && any(available.packages()[,1]==x)) {
        # update.packages(ask=F) # update dependencies, if any.
        eval(parse(text=paste("install.packages('", x, "')", sep="")))
    }

    ## if it's still missing check if it's on bioconductor
    if(!isTRUE(x %in% .packages(all.available=TRUE))) {
        bcPackages <- as.vector(read.dcf(url("https://bioconductor.org/packages/3.3/bioc/src/contrib/PACKAGES"), "Package"))

        if(any(bcPackages==x)){
            source("http://bioconductor.org/biocLite.R")
            eval(parse(text=paste("biocLite('", x, "', ask=FALSE)", sep="")))
        }
    }

    ## load it using a library function so that loadpack errors if package is still not ins
Holger Brandl's avatar
Holger Brandl committed
72
    eval(parse(text=paste("library(", x, ",  quietly=T, warn.conflicts=", warn_conflicts, ")", sep="")))
73
74
}

75
76
77
78
79
80
check_version = function(pkg_name, min_version) {
    cur_version = packageVersion(pkg_name)
    if(cur_version < min_version) stop(sprintf("Package %s needs a newer version,
               found %s, need at least %s", pkg_name, cur_version, min_version))
}
#check_version("dplyr", "0.4-1")
Holger Brandl's avatar
Holger Brandl committed
81

Holger Brandl's avatar
Holger Brandl committed
82
########################################################################################################################
Holger Brandl's avatar
Holger Brandl committed
83
## load core packages
Holger Brandl's avatar
Holger Brandl committed
84

85
86
87
loadpack(plyr)
loadpack(stringr)
loadpack(reshape2)
88
#loadpack(reshape2, quietly=T, warn_conflicts=F)
Holger Brandl's avatar
Holger Brandl committed
89

Holger Brandl's avatar
Holger Brandl committed
90
## load on purpose after plyr
91
92
93
loadpack(dplyr, warn_conflicts=F)
loadpack(magrittr, warn_conflicts=F)
loadpack(tidyr, warn_conflicts=F)
94

Holger Brandl's avatar
Holger Brandl committed
95
## needed for caching
96
97
98
99
loadpack(digest)
loadpack(readr)
suppressWarnings(loadpack(readxl)) ## supress differring build number
#loadpack(readxl) ## supress differring build number
100
101
102


## common plotting requirements since they are omnipresent
103
loadpack(ggplot2)
104
loadpack(scales, warn_conflicts=F)
105
loadpack(grid)
106

Holger Brandl's avatar
Holger Brandl committed
107
## for table exploration without using Rstudio
108
loadpack(DT)
Holger Brandl's avatar
Holger Brandl committed
109

Holger Brandl's avatar
Holger Brandl committed
110
111

## moved into datatable_commons because replaced almost everywhere with dplyr
112
#loadpack(data.table)
Holger Brandl's avatar
Holger Brandl committed
113
114
115
116
117




########################################################################################################################
Holger Brandl's avatar
Holger Brandl committed
118
#### Convenience aliases
Holger Brandl's avatar
Holger Brandl committed
119
120


Holger Brandl's avatar
Holger Brandl committed
121
echo <- function(...) cat(paste(...), fill=T)
Holger Brandl's avatar
Holger Brandl committed
122
123
124
125

ac <- function(...) as.character(...)

# string concatenation without space gaps (could/should use paste0 instead)
Holger Brandl's avatar
Holger Brandl committed
126
127
## Deprecated: use paste0 instead
#concat <- function(...) paste(..., sep="")
Holger Brandl's avatar
Holger Brandl committed
128
129
130
131
132

unlen <- function(x) length(unique(x))

pp <- function(dat) page(dat, method = "print")

Holger Brandl's avatar
Holger Brandl committed
133
134
as.df <- function(dt) as.data.frame(dt)

Holger Brandl's avatar
Holger Brandl committed
135

Holger Brandl's avatar
Holger Brandl committed
136
137
138
139
140
141
142
143
144
145
########################################################################################################################
#### data.frame manipulation


shuffle <- function(df) df[sample(nrow(df)),]

first <- function(x, n=1) head(x,n)



Holger Brandl's avatar
Holger Brandl committed
146
147
148
#vec2df <- function(namedVec) namedVec %>% {data.frame(name=names(.), value=., row.names=NULL)}
vec2df <- function(namedVec) data.frame(name=names(namedVec), value=namedVec, row.names=NULL)

Holger Brandl's avatar
Holger Brandl committed
149
150

rownames2column <- function(df, colname){
151
152
    warning("DEPRECATED Use dplyr::add_rownames directly")
    add_rownames(df, var=colname)
Holger Brandl's avatar
Holger Brandl committed
153
154
155
156
}


column2rownames<- function(df, colname){
157
    #browser()
Holger Brandl's avatar
Holger Brandl committed
158
159
160
    ## force into df to avoid dplyr problems
    df <- as.df(df)

Holger Brandl's avatar
Holger Brandl committed
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
    rownames(df) <- ac(df[,colname])
    df[colname] <- NULL
    return(df)
}

## pushing some columns to the right end of a data.frame
push_right <- function(df, pushColNames){
    df[,c(setdiff(names(df),pushColNames), pushColNames)]
}


push_left <- function(df, pushColNames){
    df[,c(pushColNames, setdiff(names(df),pushColNames))]
}


Holger Brandl's avatar
Holger Brandl committed
177
178
#http://astrostatistics.psu.edu/datasets/R/html/base/html/formals.html
set_names <- function(df, ...){
179
    #browser()
Holger Brandl's avatar
Holger Brandl committed
180
    newnames <- as.character(unlist(list(...)))
181
182
183
184

    ## automatically convert matrices to data.frames (otherwise the names set would fail
    if(is.matrix(df)) df %<>% as.data.frame()

185
    names(df) <- newnames;
Holger Brandl's avatar
Holger Brandl committed
186
187
    return(df)
}
Holger Brandl's avatar
Holger Brandl committed
188
189
#iris %>% set_names(c("setosa", "hallo")) %>% head
#iris %>% set_names("setosa", "hallo") %>% head
Holger Brandl's avatar
Holger Brandl committed
190
191


192
193
194
195
196
197
198
rify_names  <- function(df){
    warning("DEPRECATED: use pretty_columns instead");
    names(df) <- names(df) %>% str_replace_all(c(" "="_", "-"="_"));
    df
}

pretty_columns  <- function(df){ names(df) <- names(df) %>% str_replace_all(c(" "="_", "-"="_", "[.]"="_")) %>% tolower; df}
Holger Brandl's avatar
Holger Brandl committed
199
200


Holger Brandl's avatar
Holger Brandl committed
201
202
head_html <- function(df, n=5) head(df, n) %>% knitr::kable(format="html") %>% print()

Holger Brandl's avatar
Holger Brandl committed
203
204
print_head <- function(df, desc=NULL){
    print(head(df))
Holger Brandl's avatar
Holger Brandl committed
205
    print(nrow(df))
Holger Brandl's avatar
Holger Brandl committed
206
207
208
209
210
    return(df)
}


fac2char <- function(mydata, convert=names(mydata)[sapply(mydata, is.factor)]){
Holger Brandl's avatar
Holger Brandl committed
211
212
213
    if(length(convert)==0){
        return(mydata)
    }
Holger Brandl's avatar
Holger Brandl committed
214
215
216
217
218
219
220
221
222
223
224
225
226

    inputColOrder <- names(mydata)

    convertData <- subset(mydata, select= names(mydata)%in%convert)
    convertData <- as.data.frame(lapply(convertData, as.character), stringsAsFactors = FALSE)

    keepData <-  subset(mydata, select=!(names(mydata)%in%convert))
    newdata <- cbind(convertData, keepData)
    newdata <- newdata[,inputColOrder]

    return(newdata)
}

Holger Brandl's avatar
Holger Brandl committed
227
## replace R within pipe change just use ... %>% do(replaceNA(0)) %>% ...
Holger Brandl's avatar
Holger Brandl committed
228
replaceNA <- function(x, withValue) { x[is.na(x)] <- withValue; x }
Holger Brandl's avatar
Holger Brandl committed
229

Holger Brandl's avatar
Holger Brandl committed
230

Holger Brandl's avatar
Holger Brandl committed
231

Holger Brandl's avatar
Holger Brandl committed
232
## todo still needed
Holger Brandl's avatar
Holger Brandl committed
233
safe_ifelse <- function(cond, yes, no) {
Holger Brandl's avatar
Holger Brandl committed
234
235
236
237
238
239
#browser()
    isfacOrChar <- function(x) class(x)  %in% c("factor", "character")

    if (isfacOrChar(yes) | isfacOrChar(no)) {
        yes <- ac(yes)
        no <- ac(no)
240
    }
Holger Brandl's avatar
Holger Brandl committed
241
242

    ifelse(cond,yes,no)
Holger Brandl's avatar
Holger Brandl committed
243
244
}

Holger Brandl's avatar
Holger Brandl committed
245

Holger Brandl's avatar
Holger Brandl committed
246
## for na instead use mutate_each with:
Holger Brandl's avatar
Holger Brandl committed
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
#empty_as_na <- function(x) safe_ifelse(x=="", NA, x)
#empty_as_na <- function(x) ifelse(class(x)  %in% c("factor", "character") & x=="", NA, x)
empty_as_na <- function(x){
    if("factor" %in% class(x)) x <- as.character(x) ## since ifelse wont work with factors
    ifelse(as.character(x)!="", x, NA)
}

#if(F){ ## DEBUG of empty_as_na
#cond <- allJobs %>% head %$% submit_time %>% c("")
#empty_as_na( cond)
#cond <- allJobs %>% head %$% resubmission_of
#empty_as_na( cond)
#
#empty_as_na( c(1, 2, NA))
#empty_as_na( c("sdf", "sdf2", NA))
#empty_as_na( c("sdf", "sdf2", ""))
#
#myFac <- as.factor(c("sdf", "sdf2", NA))
#empty_as_na( myFac)
#ifelse(as.character(myFac)!="", myFac, NA)
#
#empty_as_na( c("sdf", "sdf2", ""))
#
#iris[1,1] <- ""
#apply(iris, 2, function(x) gsub("^$|^ $", NA, x))
#}


Holger Brandl's avatar
Holger Brandl committed
275
276
277
## see http://stackoverflow.com/questions/24172111/change-the-blank-cells-to-na/33952598#33952598


278
279
280
281
282
283
284
reload_dplyr <- function(){
    unloadNamespace('tidyr')
    unloadNamespace('dplyr')
    require(tidyr);require(dplyr)
}


Holger Brandl's avatar
Holger Brandl committed
285
286


Holger Brandl's avatar
Holger Brandl committed
287
288
289
290
## workaround for biomart
## Deprecated: load dplyr after biomart to avoid this problem
#dselect <- function(...) dplyr::select(...)

Holger Brandl's avatar
Holger Brandl committed
291

Holger Brandl's avatar
Holger Brandl committed
292
########################################################################################################################
Holger Brandl's avatar
Holger Brandl committed
293
#### Result Caching for long running tasks
Holger Brandl's avatar
Holger Brandl committed
294

Holger Brandl's avatar
Holger Brandl committed
295
296
## related: http://cran.r-project.org/web/packages/R.cache/R.cache.pdf

297
cache_it <- function(expr, filePrefix="cache"){
298
    cacheFile <- paste0(filePrefix, "_", substr(digest::digest(deparse(expr)), 1,6)) %>% paste0(".", ., ".RData")
Holger Brandl's avatar
Holger Brandl committed
299

Holger Brandl's avatar
Holger Brandl committed
300
301
302
303
304
305
306
307
308
309
310
    if(file.exists(cacheFile)){
        local(get(load(cacheFile)))
    } else {
        result <- eval(expr)
        save(result, file=cacheFile)
        result
    }
}

## Examples
#mydata <- quote(iris %>% filter(Species=="setosa")) %>% cache_it("tt")
Holger Brandl's avatar
Holger Brandl committed
311
312
#mydata <- quote(iris %>% filter(Species=="setosa")) %>% cache_it()
#mydata <- quote( { print("evaluate expr"); iris %>% filter(Species=="setosa") } ) %>% cache_it()
Holger Brandl's avatar
Holger Brandl committed
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330

########################################################################################################################
#### File System

is.directory <- function(dirname) !is.na(file.info(dirname)$isdir)


mcdir <- function(dirname){
    if(!file.exists(dirname)){
        dir.create(dirname)
    }

    setwd(dirname)
}

locload <- function(fileName) local(get(load(fileName)))


Holger Brandl's avatar
Holger Brandl committed
331
## tbd: it would be more efficient to use Reduce here (see http://stackoverflow.com/questions/34344214/how-to-join-multiple-data-frames-using-dplyr)
Holger Brandl's avatar
Holger Brandl committed
332
333
334
335
336
337
338
339
340
341
rmerge <- function(LDF, by, ...){
    DF <- LDF[[1]]
    for (i in 2:length(LDF)) {
        DF <- merge(DF, LDF[[i]], by=by)
    }
    DF
}



Holger Brandl's avatar
Holger Brandl committed
342
343
## Deprecated: use trim_ext instead
trimEnd <- function(fileNames, ...) trim_ext(fileNames, ...)
Holger Brandl's avatar
Holger Brandl committed
344

Holger Brandl's avatar
Holger Brandl committed
345
trim_ext <-function(fileNames, exts=c()){
Holger Brandl's avatar
Holger Brandl committed
346
347
348
349
350
351
352
    for(fileExt in exts){
        fileNames <- str_replace(fileNames, paste(fileExt, "$",sep=""), "")
    }

    fileNames
}

Holger Brandl's avatar
Holger Brandl committed
353
## DEPRECATED Use write_tsv instead
Holger Brandl's avatar
Holger Brandl committed
354
355
write.delim <- function(df, file, header=TRUE,...){
    write.table(df, file, row.names=FALSE, col.names=header, sep="\t", ...)
Holger Brandl's avatar
Holger Brandl committed
356
357
358
359
360
361
362
363
364
365
}

rmSomeElements <- function(vec, toDel) vec[!(vec %in% toDel)]

rmLastElement <- function(vec) vec[-length(vec)]


########################################################################################################################
## Memory management

Holger Brandl's avatar
Holger Brandl committed
366

Holger Brandl's avatar
Holger Brandl committed
367
# improved list of objects
Holger Brandl's avatar
Holger Brandl committed
368
369
lsos <- function (pos = 1, pattern, order.by, decreasing=FALSE, head=FALSE, n=5) {
    napply <- function(names, fn) sapply(names, function(x) fn(get(x, pos = pos)))
Holger Brandl's avatar
Holger Brandl committed
370
    names <- ls(pos = pos, pattern = pattern)
Holger Brandl's avatar
Holger Brandl committed
371

Holger Brandl's avatar
Holger Brandl committed
372
373
374
375
376
    obj.class <- napply(names, function(x) as.character(class(x))[1])
    obj.mode <- napply(names, mode)
    obj.type <- ifelse(is.na(obj.class), obj.mode, obj.class)
    obj.size <- napply(names, object.size)/1000000
    obj.dim <- t(napply(names, function(x)
Holger Brandl's avatar
Holger Brandl committed
377

378
    as.numeric(dim(x))[1:2]))
Holger Brandl's avatar
Holger Brandl committed
379
380
    vec <- is.na(obj.dim)[, 1] & (obj.type != "function")
    obj.dim[vec, 1] <- napply(names, length)[vec]
Holger Brandl's avatar
Holger Brandl committed
381

Holger Brandl's avatar
Holger Brandl committed
382
383
    out <- data.frame(obj.type, obj.size, obj.dim)
    names(out) <- c("Type", "Size", "Rows", "Columns")
Holger Brandl's avatar
Holger Brandl committed
384

Holger Brandl's avatar
Holger Brandl committed
385
    if (!missing(order.by))
386
    out <- out[order(out[[order.by]], decreasing=decreasing), ]
Holger Brandl's avatar
Holger Brandl committed
387
388
389

    if (head) out <- head(out, n)

Holger Brandl's avatar
Holger Brandl committed
390
391
392
393
394
    out <- transform(out, var_name=rownames(out))
    rownames(out) <- NULL
    arrange(out, Size)
}

Holger Brandl's avatar
Holger Brandl committed
395
# shorthand that just shows top 1 results
Holger Brandl's avatar
Holger Brandl committed
396
397
398
399
lsosh <- function(..., n=10) {
    lsos(..., order.by="Size", decreasing=TRUE, head=TRUE, n=n)
}

Holger Brandl's avatar
Holger Brandl committed
400
401
402
403
404
405
406
407
408
409
########################################################################################################################
### Statistics


## outlier handling
trim_outliers <- function(values, range=quantile(values, c(0.05, 0.95)))  pmax(range[1], pmin(range[2], values))

## use trim_outliers instead
#limit_range <- function(values, range)  pmax(range[1], pmin(range[2], values))

Holger Brandl's avatar
Holger Brandl committed
410
se <- function(x) sd(x, na.rm=TRUE) / sqrt(sum(!is.na(x)))
411
412
413
414
415
416
417
418
419


########################################################################################################################
### Misc

## inspired by http://stackoverflow.com/questions/8343509/better-error-message-for-stopifnot
assert <- function (expr, error) {
    if (! expr) stop(error, call. = FALSE)
}