annotate IDchoice/IDchoice_script.R @ 1:dfd23f54f61f draft default tip

Uploaded
author melpetera
date Thu, 19 Dec 2019 10:31:03 +0000
parents 931f326198ba
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
931f326198ba Uploaded
melpetera
parents:
diff changeset
1 ################################################################################################
931f326198ba Uploaded
melpetera
parents:
diff changeset
2 # ID CHOICE #
931f326198ba Uploaded
melpetera
parents:
diff changeset
3 # #
931f326198ba Uploaded
melpetera
parents:
diff changeset
4 # User: Galaxy #
931f326198ba Uploaded
melpetera
parents:
diff changeset
5 # Starting date: 01-06-2017 #
931f326198ba Uploaded
melpetera
parents:
diff changeset
6 # V-0.1: First version of code #
1
dfd23f54f61f Uploaded
melpetera
parents: 0
diff changeset
7 # V-1.0: Code adjusted to user feedback #
0
931f326198ba Uploaded
melpetera
parents:
diff changeset
8 # #
931f326198ba Uploaded
melpetera
parents:
diff changeset
9 # #
931f326198ba Uploaded
melpetera
parents:
diff changeset
10 # Input files: dataMatrix ; Metadata file #
931f326198ba Uploaded
melpetera
parents:
diff changeset
11 # Output files: dataMatrix ; Metadata file #
931f326198ba Uploaded
melpetera
parents:
diff changeset
12 # #
931f326198ba Uploaded
melpetera
parents:
diff changeset
13 # Dependencies: RcheckLibrary.R ; miniTools.R (easyRlibrary) #
931f326198ba Uploaded
melpetera
parents:
diff changeset
14 # #
931f326198ba Uploaded
melpetera
parents:
diff changeset
15 ################################################################################################
931f326198ba Uploaded
melpetera
parents:
diff changeset
16
931f326198ba Uploaded
melpetera
parents:
diff changeset
17 # Parameters (for dev)
931f326198ba Uploaded
melpetera
parents:
diff changeset
18 if(FALSE){
931f326198ba Uploaded
melpetera
parents:
diff changeset
19 DM.name <- "CaracSpe_dataMatrix.txt"
931f326198ba Uploaded
melpetera
parents:
diff changeset
20 meta.name <- "CaracSpe_variableMetadata.txt"
931f326198ba Uploaded
melpetera
parents:
diff changeset
21 metype <- "variable"
931f326198ba Uploaded
melpetera
parents:
diff changeset
22 #coloname <- "namecustom"
931f326198ba Uploaded
melpetera
parents:
diff changeset
23 coloname <- "B"
931f326198ba Uploaded
melpetera
parents:
diff changeset
24 makeun <- "yes"
931f326198ba Uploaded
melpetera
parents:
diff changeset
25 DMout <- "ID_DM.txt"
931f326198ba Uploaded
melpetera
parents:
diff changeset
26 metaout <- paste0("ID_",metype,"meta.txt")
931f326198ba Uploaded
melpetera
parents:
diff changeset
27 }
931f326198ba Uploaded
melpetera
parents:
diff changeset
28
931f326198ba Uploaded
melpetera
parents:
diff changeset
29
931f326198ba Uploaded
melpetera
parents:
diff changeset
30 id.choice <- function(DM.name,meta.name,metype,coloname,makeun,DMout,metaout){
931f326198ba Uploaded
melpetera
parents:
diff changeset
31 # This function allows to replace original IDs with other ones from one metadata table.
931f326198ba Uploaded
melpetera
parents:
diff changeset
32 #
931f326198ba Uploaded
melpetera
parents:
diff changeset
33 # Parameters:
931f326198ba Uploaded
melpetera
parents:
diff changeset
34 # - DM.name, meta.name: dataMatrix and metadata files' access respectively
931f326198ba Uploaded
melpetera
parents:
diff changeset
35 # - metype: "sample" or "variable" depending on metadata content
931f326198ba Uploaded
melpetera
parents:
diff changeset
36 # - coloname: name of the metadata column to be used as new ID
931f326198ba Uploaded
melpetera
parents:
diff changeset
37 # - makeun: "yes" or "no" depending on user choice if new IDs are not unique ("yes"=conversion to unique ID)
931f326198ba Uploaded
melpetera
parents:
diff changeset
38 # - DMout, metaout: output files' access
931f326198ba Uploaded
melpetera
parents:
diff changeset
39
931f326198ba Uploaded
melpetera
parents:
diff changeset
40
931f326198ba Uploaded
melpetera
parents:
diff changeset
41 # Input --------------------------------------------------------------
931f326198ba Uploaded
melpetera
parents:
diff changeset
42
931f326198ba Uploaded
melpetera
parents:
diff changeset
43 DM <- read.table(DM.name,header=TRUE,sep="\t",check.names=FALSE)
931f326198ba Uploaded
melpetera
parents:
diff changeset
44 meta <- read.table(meta.name,header=TRUE,sep="\t",check.names=FALSE,colClasses="character")
931f326198ba Uploaded
melpetera
parents:
diff changeset
45
931f326198ba Uploaded
melpetera
parents:
diff changeset
46 # Table match check
931f326198ba Uploaded
melpetera
parents:
diff changeset
47 table.check <- match2(DM,meta,metype)
931f326198ba Uploaded
melpetera
parents:
diff changeset
48 check.err(table.check)
931f326198ba Uploaded
melpetera
parents:
diff changeset
49
1
dfd23f54f61f Uploaded
melpetera
parents: 0
diff changeset
50 # Keep metadata original order tracked ----------------------------------------
dfd23f54f61f Uploaded
melpetera
parents: 0
diff changeset
51
dfd23f54f61f Uploaded
melpetera
parents: 0
diff changeset
52 meta <- data.frame(meta,ori=1:nrow(meta))
dfd23f54f61f Uploaded
melpetera
parents: 0
diff changeset
53
0
931f326198ba Uploaded
melpetera
parents:
diff changeset
54
931f326198ba Uploaded
melpetera
parents:
diff changeset
55 # Checking unicity of new IDs ----------------------------------------
931f326198ba Uploaded
melpetera
parents:
diff changeset
56
931f326198ba Uploaded
melpetera
parents:
diff changeset
57 numcol <- which(colnames(meta)==coloname)
931f326198ba Uploaded
melpetera
parents:
diff changeset
58 if(length(numcol)==0) {
931f326198ba Uploaded
melpetera
parents:
diff changeset
59 stop(paste0("\n-------\nWarning: no '",coloname,"' column detected in ",metype," metadata!",
931f326198ba Uploaded
melpetera
parents:
diff changeset
60 "\nPlease check your metadata file (column names are case-sensitive).\n-------\n"))
931f326198ba Uploaded
melpetera
parents:
diff changeset
61 }
931f326198ba Uploaded
melpetera
parents:
diff changeset
62
931f326198ba Uploaded
melpetera
parents:
diff changeset
63 unicity <- duplicated(meta[,numcol])
931f326198ba Uploaded
melpetera
parents:
diff changeset
64
931f326198ba Uploaded
melpetera
parents:
diff changeset
65 if(sum(unicity)>0){
931f326198ba Uploaded
melpetera
parents:
diff changeset
66 if(makeun=="no"){
931f326198ba Uploaded
melpetera
parents:
diff changeset
67 #Sending back an explicit error
931f326198ba Uploaded
melpetera
parents:
diff changeset
68 duptable <- t(t(table(meta[,numcol][unicity])+1))
931f326198ba Uploaded
melpetera
parents:
diff changeset
69 stop(paste0("\n-------\nYour '",coloname,"' column contains duplicates:\n"),
931f326198ba Uploaded
melpetera
parents:
diff changeset
70 paste(rownames(duptable),duptable,sep=": ",collapse="\n"),paste0("\nSince identifiers are meant to be unique, ",
931f326198ba Uploaded
melpetera
parents:
diff changeset
71 "please check your data or use the 'Force unicity' option to force unicity.\n-------\n"))
931f326198ba Uploaded
melpetera
parents:
diff changeset
72
931f326198ba Uploaded
melpetera
parents:
diff changeset
73 }else{
931f326198ba Uploaded
melpetera
parents:
diff changeset
74 #Making unique names
1
dfd23f54f61f Uploaded
melpetera
parents: 0
diff changeset
75 meta <- cbind(meta,newID=make.unique(meta[,numcol],sep="_"))
0
931f326198ba Uploaded
melpetera
parents:
diff changeset
76 }
931f326198ba Uploaded
melpetera
parents:
diff changeset
77 }else{
931f326198ba Uploaded
melpetera
parents:
diff changeset
78 #No unicity problem
1
dfd23f54f61f Uploaded
melpetera
parents: 0
diff changeset
79 meta <- cbind(meta,newID=meta[,numcol])
0
931f326198ba Uploaded
melpetera
parents:
diff changeset
80 }
931f326198ba Uploaded
melpetera
parents:
diff changeset
81
931f326198ba Uploaded
melpetera
parents:
diff changeset
82
931f326198ba Uploaded
melpetera
parents:
diff changeset
83 # Merging tables -----------------------------------------------------
931f326198ba Uploaded
melpetera
parents:
diff changeset
84
931f326198ba Uploaded
melpetera
parents:
diff changeset
85 #Transposing the dataMatrix if necessary
931f326198ba Uploaded
melpetera
parents:
diff changeset
86 if(metype=="sample"){
931f326198ba Uploaded
melpetera
parents:
diff changeset
87 rownames(DM) <- DM[,1]
931f326198ba Uploaded
melpetera
parents:
diff changeset
88 DM <- DM[,-1]
931f326198ba Uploaded
melpetera
parents:
diff changeset
89 DM <- t(DM)
931f326198ba Uploaded
melpetera
parents:
diff changeset
90 DM <- data.frame(sample=row.names(DM),DM,check.names=FALSE)
931f326198ba Uploaded
melpetera
parents:
diff changeset
91 rownames(DM) <- NULL
931f326198ba Uploaded
melpetera
parents:
diff changeset
92 }
931f326198ba Uploaded
melpetera
parents:
diff changeset
93
931f326198ba Uploaded
melpetera
parents:
diff changeset
94 comb.data <- merge(x=meta,y=DM,by.x=1,by.y=1)
931f326198ba Uploaded
melpetera
parents:
diff changeset
95 comb.data <- comb.data[order(comb.data$ori),]
931f326198ba Uploaded
melpetera
parents:
diff changeset
96
931f326198ba Uploaded
melpetera
parents:
diff changeset
97
931f326198ba Uploaded
melpetera
parents:
diff changeset
98 # Changing IDs -------------------------------------------------------
931f326198ba Uploaded
melpetera
parents:
diff changeset
99
1
dfd23f54f61f Uploaded
melpetera
parents: 0
diff changeset
100 DM <- comb.data[,-c(1:(ncol(meta)-1))]
0
931f326198ba Uploaded
melpetera
parents:
diff changeset
101 if(makeun=="no"){
931f326198ba Uploaded
melpetera
parents:
diff changeset
102 comb.data <- comb.data[,c(numcol,which(colnames(meta)!=coloname))]
931f326198ba Uploaded
melpetera
parents:
diff changeset
103 meta <- comb.data[,c(1:(ncol(meta)-2))]
931f326198ba Uploaded
melpetera
parents:
diff changeset
104 }else{
1
dfd23f54f61f Uploaded
melpetera
parents: 0
diff changeset
105 meta <- comb.data[,c(ncol(meta),1:(ncol(meta)-2))]
0
931f326198ba Uploaded
melpetera
parents:
diff changeset
106 }
931f326198ba Uploaded
melpetera
parents:
diff changeset
107
931f326198ba Uploaded
melpetera
parents:
diff changeset
108 #Transposing back the dataMatrix if necessary
931f326198ba Uploaded
melpetera
parents:
diff changeset
109 if(metype=="sample"){
931f326198ba Uploaded
melpetera
parents:
diff changeset
110 rownames(DM) <- DM[,1]
931f326198ba Uploaded
melpetera
parents:
diff changeset
111 DM <- DM[,-1]
931f326198ba Uploaded
melpetera
parents:
diff changeset
112 DM <- t(DM)
931f326198ba Uploaded
melpetera
parents:
diff changeset
113 DM <- data.frame(sample=row.names(DM),DM,check.names=FALSE)
931f326198ba Uploaded
melpetera
parents:
diff changeset
114 rownames(DM) <- NULL
931f326198ba Uploaded
melpetera
parents:
diff changeset
115 }
931f326198ba Uploaded
melpetera
parents:
diff changeset
116
931f326198ba Uploaded
melpetera
parents:
diff changeset
117
931f326198ba Uploaded
melpetera
parents:
diff changeset
118 # Output -------------------------------------------------------------
931f326198ba Uploaded
melpetera
parents:
diff changeset
119
931f326198ba Uploaded
melpetera
parents:
diff changeset
120 # Writing the table
931f326198ba Uploaded
melpetera
parents:
diff changeset
121 write.table(DM,DMout,sep="\t",quote=FALSE,row.names=FALSE)
931f326198ba Uploaded
melpetera
parents:
diff changeset
122 write.table(meta,metaout,sep="\t",quote=FALSE,row.names=FALSE)
931f326198ba Uploaded
melpetera
parents:
diff changeset
123
931f326198ba Uploaded
melpetera
parents:
diff changeset
124
931f326198ba Uploaded
melpetera
parents:
diff changeset
125 } # End of id.choice
931f326198ba Uploaded
melpetera
parents:
diff changeset
126
931f326198ba Uploaded
melpetera
parents:
diff changeset
127
931f326198ba Uploaded
melpetera
parents:
diff changeset
128 # Typical function call
931f326198ba Uploaded
melpetera
parents:
diff changeset
129 # id.choice(DM.name,meta.name,metype,coloname,makeun,DMout,metaout)