SCM

SCM Repository

[tm] Diff of /pkg/R/corpus.R
ViewVC logotype

Diff of /pkg/R/corpus.R

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

trunk/R/textmin/R/textdoccol.R revision 62, Tue Oct 24 10:08:58 2006 UTC pkg/R/corpus.R revision 950, Thu May 14 15:17:18 2009 UTC
# Line 1  Line 1 
1  # Author: Ingo Feinerer  # Author: Ingo Feinerer
2    
3  setGeneric("TextDocCol", function(object, parser = plaintext.parser, lod = FALSE) standardGeneric("TextDocCol"))  FCorpus <- function(object, readerControl = list(language = "eng")) {
4  setMethod("TextDocCol",      if (is.null(readerControl$language))
5            signature(object = "character"),          readerControl$language <- "eng"
6            function(object, parser = plaintext.parser, lod = FALSE) {  
7                filelist <- dir(object, full.names = TRUE)      if (!object@Vectorized)
8                tdl <- lapply(filelist, parser, lod)          stop("Source is not vectorized")
9                return(new("TextDocCol", .Data = tdl))  
10            })      tdl <- lapply(mapply(c, pGetElem(object), id = seq_len(object@Length), SIMPLIFY = FALSE),
11                      function(x) readSlim(x[c("content", "uri")],
12  plaintext.parser <- function(file, lod) {                                         readerControl$language,
13      id <- file                                         as.character(x$id)))
14      origin <- dirname(file)  
15        new("FCorpus", .Data = tdl)
16      doc <- new("PlainTextDocument", FileName = file, Cached = FALSE, Author = "Unknown",  }
17                 DateTimeStamp = date(), Description = "", ID = id, Origin = origin, Heading = "")  
18    PCorpus <- function(object,
19      if (lod) {                      readerControl = list(reader = object@DefaultReader, language = "eng"),
20          doc <- loadFileIntoMem(doc)                      dbControl = list(dbName = "", dbType = "DB1"),
21      }                      ...) {
22        if (is.null(readerControl$reader))
23      return(doc)          readerControl$reader <- object@DefaultReader
24  }      if (is(readerControl$reader, "FunctionGenerator"))
25            readerControl$reader <- readerControl$reader(...)
26  reuters21578xml.parser <- function(file, lod) {      if (is.null(readerControl$language))
27      tree <- xmlTreeParse(file)          readerControl$language <- "eng"
28      node <- xmlRoot(tree)  
29        if (!filehash::dbCreate(dbControl$dbName, dbControl$dbType))
30      # The <AUTHOR></AUTHOR> tag is unfortunately NOT obligatory!          stop("error in creating database")
31      if (!is.null(node[["TEXT"]][["AUTHOR"]]))      db <- filehash::dbInit(dbControl$dbName, dbControl$dbType)
32          author <- xmlValue(node[["TEXT"]][["AUTHOR"]])  
33        # Allocate memory in advance if length is known
34        tdl <- if (object@Length > 0)
35            vector("list", as.integer(object@Length))
36      else      else
37          author <- ""          list()
38    
39      datetimestamp <- xmlValue(node[["DATE"]])      counter <- 1
40      description <- ""      while (!eoi(object)) {
41      id <- xmlAttrs(node)[["NEWID"]]          object <- stepNext(object)
42            elem <- getElem(object)
43      # The <TITLE></TITLE> tag is unfortunately NOT obligatory!          doc <- readerControl$reader(elem, readerControl$language, as.character(counter))
44      if (!is.null(node[["TEXT"]][["TITLE"]]))          filehash::dbInsert(db, ID(doc), doc)
45          heading <- xmlValue(node[["TEXT"]][["TITLE"]])          if (object@Length > 0) tdl[[counter]] <- ID(doc)
46            else tdl <- c(tdl, ID(doc))
47            counter <- counter + 1
48        }
49    
50        df <- data.frame(MetaID = rep(0, length(tdl)), stringsAsFactors = FALSE)
51        filehash::dbInsert(db, "DMetaData", df)
52        dmeta.df <- data.frame(key = "DMetaData", subset = I(list(NA)))
53    
54        cmeta.node <- new("MetaDataNode",
55                          NodeID = 0,
56                          MetaData = list(create_date = as.POSIXlt(Sys.time(), tz = "GMT"), creator = Sys.getenv("LOGNAME")),
57                          children = list())
58    
59        new("PCorpus", .Data = tdl, DMetaData = dmeta.df, CMetaData = cmeta.node, DBControl = dbControl)
60    }
61    
62    # The "..." are additional arguments for the FunctionGenerator reader
63    SCorpus <- Corpus <- function(object,
64                        readerControl = list(reader = object@DefaultReader, language = "eng"),
65                        ...) {
66        if (is.null(readerControl$reader))
67            readerControl$reader <- object@DefaultReader
68        if (is(readerControl$reader, "FunctionGenerator"))
69            readerControl$reader <- readerControl$reader(...)
70        if (is.null(readerControl$language))
71            readerControl$language <- "eng"
72    
73        # Allocate memory in advance if length is known
74        tdl <- if (object@Length > 0)
75            vector("list", as.integer(object@Length))
76      else      else
77          heading <- ""          list()
   
     topics <- unlist(xmlApply(node[["TOPICS"]], function(x) xmlValue(x)), use.names = FALSE)  
78    
79      doc <- new("XMLTextDocument", FileName = file, Cached = FALSE, Author = author,      if (object@Vectorized)
80                 DateTimeStamp = datetimestamp, Description = "", ID = id, Origin = "Reuters-21578 XML",          tdl <- lapply(mapply(c, pGetElem(object), id = seq_len(object@Length), SIMPLIFY = FALSE),
81                 Heading = heading, LocalMetaData = list(Topics = topics))                        function(x) readerControl$reader(x[c("content", "uri")],
82                                                           readerControl$language,
83      if (lod) {                                                         as.character(x$id)))
84          doc <- loadFileIntoMem(doc)      else {
85            counter <- 1
86            while (!eoi(object)) {
87                object <- stepNext(object)
88                elem <- getElem(object)
89                doc <- readerControl$reader(elem, readerControl$language, as.character(counter))
90                if (object@Length > 0)
91                    tdl[[counter]] <- doc
92                else
93                    tdl <- c(tdl, list(doc))
94                counter <- counter + 1
95      }      }
   
     return(doc)  
96  }  }
97    
98  rcv1.parser <- function(file, lod) {      df <- data.frame(MetaID = rep(0, length(tdl)), stringsAsFactors = FALSE)
99      tree <- xmlTreeParse(file)      cmeta.node <- new("MetaDataNode",
100      node <- xmlRoot(tree)                        NodeID = 0,
101                          MetaData = list(create_date = as.POSIXlt(Sys.time(), tz = "GMT"), creator = Sys.getenv("LOGNAME")),
102      datetimestamp <- xmlAttrs(node)[["date"]]                        children = list())
     id <- xmlAttrs(node)[["itemid"]]  
     heading <- xmlValue(node[["title"]])  
   
     doc <- new("XMLTextDocument", FileName = file, Cached = FALSE, Author = "",  
                DateTimeStamp = datetimestamp, Description = "", ID = id, Origin = "Reuters Corpus Volume 1 XML",  
                Heading = heading)  
103    
104      if (lod) {      new("SCorpus", .Data = tdl, DMetaData = df, CMetaData = cmeta.node)
         doc <- loadFileIntoMem(doc)  
105      }      }
106    
107      return(doc)  setGeneric("tmMap", function(object, FUN, ..., lazy = FALSE) standardGeneric("tmMap"))
108  }  setMethod("tmMap",
109              signature(object = "FCorpus", FUN = "function"),
110  uci.kdd.newsgroup.parser <-  function(file, lod) {            function(object, FUN, ..., lazy = FALSE) {
111      mail <- readLines(file)                if (lazy)
112      author <- gsub("From: ", "", grep("^From:", mail, value = TRUE))                    warning("lazy mapping is deactivated")
     datetimestamp <- gsub("Date: ", "", grep("^Date:", mail, value = TRUE))  
     origin <- gsub("Path: ", "", grep("^Path:", mail, value = TRUE))  
     heading <- gsub("Subject: ", "", grep("^Subject:", mail, value = TRUE))  
     newsgroup <- gsub("Newsgroups: ", "", grep("^Newsgroups:", mail, value = TRUE))  
113    
114      new("NewsgroupDocument", FileName = file, Cached = FALSE, Author = author, DateTimeStamp = datetimestamp,                lapply(object, FUN, ..., DMetaData = data.frame())
115          Description = "", ID = file, Origin = origin, Heading = heading, Newsgroup = newsgroup)            })
116    setMethod("tmMap",
117      if (lod) {            signature(object = "SCorpus", FUN = "function"),
118          doc <- loadFileIntoMem(doc)            function(object, FUN, ..., lazy = FALSE) {
119                  result <- object
120                  # Lazy mapping
121                  if (lazy) {
122                      lazyTmMap <- meta(object, tag = "lazyTmMap", type = "corpus")
123                      if (is.null(lazyTmMap)) {
124                          meta(result, tag = "lazyTmMap", type = "corpus") <-
125                              list(index = rep(TRUE, length(result)),
126                                   maps = list(function(x, DMetaData) FUN(x, ..., DMetaData = DMetaData)))
127      }      }
128                      else {
129      return(doc)                        lazyTmMap$maps <- c(lazyTmMap$maps, list(function(x, DMetaData) FUN(x, ..., DMetaData = DMetaData)))
130                          meta(result, tag = "lazyTmMap", type = "corpus") <- lazyTmMap
131  }  }
   
 # Parse a <newsitem></newsitem> element from a well-formed RCV1 XML file  
 rcv1.to.plain <- function(node) {  
     datetimestamp <- xmlAttrs(node)[["date"]]  
     id <- xmlAttrs(node)[["itemid"]]  
     origin <- "Reuters Corpus Volume 1 XML"  
     corpus <- unlist(xmlApply(node[["text"]], xmlValue), use.names = FALSE)  
     heading <- xmlValue(node[["title"]])  
   
     new("PlainTextDocument", .Data = corpus, Author = "", DateTimeStamp = datetimestamp,  
         Description = "", ID = id, Origin = "Reuters Corpus Volume 1 XML", Heading = heading)  
132  }  }
133                  else {
134  # Parse a <REUTERS></REUTERS> element from a well-formed Reuters-21578 XML file                    result@.Data <- if (clusterAvailable())
135  reuters21578xml.to.plain <- function(node) {                        snow::parLapply(snow::getMPIcluster(), object, FUN, ..., DMetaData = DMetaData(object))
     # The <AUTHOR></AUTHOR> tag is unfortunately NOT obligatory!  
     if (!is.null(node[["TEXT"]][["AUTHOR"]]))  
         author <- xmlValue(node[["TEXT"]][["AUTHOR"]])  
136      else      else
137          author <- ""                        lapply(object, FUN, ..., DMetaData = DMetaData(object))
   
     datetimestamp <- xmlValue(node[["DATE"]])  
     description <- ""  
     id <- xmlAttrs(node)[["NEWID"]]  
   
     origin <- "Reuters-21578 XML"  
   
     # The <BODY></BODY> tag is unfortunately NOT obligatory!  
     if (!is.null(node[["TEXT"]][["BODY"]]))  
         corpus <- xmlValue(node[["TEXT"]][["BODY"]])  
     else  
         corpus <- ""  
   
     # The <TITLE></TITLE> tag is unfortunately NOT obligatory!  
     if (!is.null(node[["TEXT"]][["TITLE"]]))  
         heading <- xmlValue(node[["TEXT"]][["TITLE"]])  
     else  
         heading <- ""  
   
     topics <- unlist(xmlApply(node[["TOPICS"]], function(x) xmlValue(x)), use.names = FALSE)  
   
     new("PlainTextDocument", .Data = corpus, Cached = TRUE, Author = author, DateTimeStamp = datetimestamp,  
         Description = description, ID = id, Origin = origin, Heading = heading, LocalMetaData = list(Topics = topics))  
 }  
   
 setGeneric("loadFileIntoMem", function(object) standardGeneric("loadFileIntoMem"))  
 setMethod("loadFileIntoMem",  
           signature(object = "PlainTextDocument"),  
           function(object) {  
               if (!Cached(object)) {  
                   corpus <- readLines(FileName(object))  
                   Corpus(object) <- corpus  
                   Cached(object) <- TRUE  
                   return(object)  
               } else {  
                   return(object)  
138                }                }
139                  result
140            })            })
141  setMethod("loadFileIntoMem",  setMethod("tmMap",
142              signature(object = "PCorpus", FUN = "function"),
143              function(object, FUN, ..., lazy = FALSE) {
144                  # TODO: When should lazy mapping be conceptually available?
145                  if (lazy)
146                      warning("lazy mapping is deactived when using database backend")
147                  db <- filehash::dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
148                  i <- 1
149                  for (id in unlist(object)) {
150                      db[[id]] <- FUN(object[[i]], ..., DMetaData = DMetaData(object))
151                      i <- i + 1
152                  }
153                  # Suggested by Christian Buchta
154                  filehash::dbReorganize(db)
155    
156                  object
157              })
158    
159    # Materialize lazy mappings
160    # Improvements by Christian Buchta
161    materialize <- function(corpus, range = seq_along(corpus)) {
162        lazyTmMap <- meta(corpus, tag = "lazyTmMap", type = "corpus")
163        if (!is.null(lazyTmMap)) {
164           # Make valid and lazy index
165           idx <- (seq_along(corpus) %in% range) & lazyTmMap$index
166           if (any(idx)) {
167               res <- corpus@.Data[idx]
168               for (m in lazyTmMap$maps)
169                   res <- lapply(res, m, DMetaData = DMetaData(corpus))
170               corpus@.Data[idx] <- res
171               lazyTmMap$index[idx] <- FALSE
172           }
173        }
174        # Clean up if everything is materialized
175        if (!any(lazyTmMap$index))
176            lazyTmMap <- NULL
177        meta(corpus, tag = "lazyTmMap", type = "corpus") <- lazyTmMap
178        corpus
179    }
180    
181    setGeneric("asPlain", function(object, FUN, ...) standardGeneric("asPlain"))
182    setMethod("asPlain", signature(object = "PlainTextDocument"),
183              function(object, FUN, ...) object)
184    setMethod("asPlain",
185            signature(object =  "XMLTextDocument"),            signature(object =  "XMLTextDocument"),
           function(object) {  
               if (!Cached(object)) {  
                   file <- FileName(object)  
                   doc <- xmlTreeParse(file)  
                   class(doc) <- "list"  
                   Corpus(object) <- doc  
                   Cached(object) <- TRUE  
                   return(object)  
               } else {  
                   return(object)  
               }  
           })  
 setMethod("loadFileIntoMem",  
           signature(object = "NewsgroupDocument"),  
           function(object) {  
               if (!Cached(object)) {  
                   mail <- readLines(FileName(object))  
                   Cached(object) <- TRUE  
                   index <- grep("^Lines:", mail)  
                   Corpus(object) <- mail[(index + 1):length(mail)]  
                   return(object)  
               } else {  
                   return(object)  
               }  
           })  
   
 setGeneric("tm_transform", function(object, FUN, ...) standardGeneric("tm_transform"))  
 setMethod("tm_transform",  
           signature(object = "TextDocCol", FUN = "function"),  
186            function(object, FUN, ...) {            function(object, FUN, ...) {
187                result <- as(lapply(object, FUN, ..., GlobalMetaData = GlobalMetaData(object)), "TextDocCol")                require("XML")
               result@GlobalMetaData <- GlobalMetaData(object)  
               return(result)  
           })  
188    
189  setGeneric("toPlainTextDocument", function(object, FUN, ...) standardGeneric("toPlainTextDocument"))                corpus <- Content(object)
190  setMethod("toPlainTextDocument",  
191            signature(object = "PlainTextDocument"),                # As XMLDocument is no native S4 class, restore valid information
192            function(object, FUN, ...) {                class(corpus) <- "XMLDocument"
193                return(object)                names(corpus) <- c("doc","dtd")
194    
195                  return(FUN(xmlRoot(corpus), ...))
196            })            })
197  setMethod("toPlainTextDocument",  setMethod("asPlain",
198            signature(object = "XMLTextDocument", FUN = "function"),            signature(object = "Reuters21578Document"),
199            function(object, FUN, ...) {            function(object, FUN, ...) {
200                if (!Cached(object))                require("XML")
                   object <- loadFileIntoMem(object)  
201    
202                corpus <- Corpus(object)                FUN <- convertReut21578XMLPlain
203                  corpus <- Content(object)
204    
205                # As XMLDocument is no native S4 class, restore valid information                # As XMLDocument is no native S4 class, restore valid information
206                class(corpus) <- "XMLDocument"                class(corpus) <- "XMLDocument"
# Line 207  Line 208 
208    
209                return(FUN(xmlRoot(corpus), ...))                return(FUN(xmlRoot(corpus), ...))
210            })            })
211    setMethod("asPlain", signature(object = "RCV1Document"),
212  setGeneric("stemTextDocument", function(object, ...) standardGeneric("stemTextDocument"))            function(object, FUN, ...) convertRCV1Plain(object, ...))
213  setMethod("stemTextDocument",  setMethod("asPlain",
214            signature(object = "PlainTextDocument"),            signature(object = "NewsgroupDocument"),
215            function(object, ...) {            function(object, FUN, ...) {
216                if (!Cached(object))                new("PlainTextDocument", .Data = Content(object), Author = Author(object),
217                    object <- loadFileIntoMem(object)                    DateTimeStamp = DateTimeStamp(object), Description = Description(object), ID = ID(object),
218                      Origin = Origin(object), Heading = Heading(object), Language = Language(object),
219                require(Rstem)                    LocalMetaData = LocalMetaData(object))
220                splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))            })
221                stemmedCorpus <- wordStem(splittedCorpus, ...)  setMethod("asPlain",
222                Corpus(object) <- paste(stemmedCorpus, collapse = " ")            signature(object = "StructuredTextDocument"),
223                return(object)            function(object, FUN, ...) {
224                  new("PlainTextDocument", .Data = unlist(Content(object)),
225                      Author = Author(object), DateTimeStamp = DateTimeStamp(object),
226                      Description = Description(object), ID = ID(object), Origin = Origin(object),
227                      Heading = Heading(object), Language = Language(object),
228                      LocalMetaData = LocalMetaData(object))
229              })
230    
231    setGeneric("tmFilter", function(object, ..., FUN = searchFullText, doclevel = TRUE) standardGeneric("tmFilter"))
232    setMethod("tmFilter", signature(object = "Corpus"),
233              function(object, ..., FUN = searchFullText, doclevel = TRUE)
234                  object[tmIndex(object, ..., FUN = FUN, doclevel = doclevel)])
235    
236    setGeneric("tmIndex", function(object, ..., FUN = searchFullText, doclevel = TRUE) standardGeneric("tmIndex"))
237    setMethod("tmIndex",
238              signature(object = "Corpus"),
239              function(object, ..., FUN = searchFullText, doclevel = TRUE) {
240                  if (!is.null(attr(FUN, "doclevel")))
241                      doclevel <- attr(FUN, "doclevel")
242                  if (doclevel) {
243                      if (clusterAvailable())
244                          return(snow::parSapply(snow::getMPIcluster(), object, FUN, ..., DMetaData = DMetaData(object)))
245                      else
246                          return(sapply(object, FUN, ..., DMetaData = DMetaData(object)))
247                  }
248                  else
249                      return(FUN(object, ...))
250            })            })
251    
252  setGeneric("removeStopWords", function(object, stopwords, ...) standardGeneric("removeStopWords"))  # TODO: Replace with c(Corpus, TextDocument)?
253  setMethod("removeStopWords",  setGeneric("appendElem", function(object, data, meta = NULL) standardGeneric("appendElem"))
254            signature(object = "PlainTextDocument", stopwords = "character"),  setMethod("appendElem",
255            function(object, stopwords, ...) {            signature(object = "Corpus", data = "TextDocument"),
256                if (!Cached(object))            function(object, data, meta = NULL) {
257                    object <- loadFileIntoMem(object)                if (DBControl(object)[["useDb"]] && require("filehash")) {
258                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
259                require(Rstem)                    if (dbExists(db, ID(data)))
260                splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))                        warning("document with identical ID already exists")
261                noStopwordsCorpus <- splittedCorpus[!splittedCorpus %in% stopwords]                    dbInsert(db, ID(data), data)
262                Corpus(object) <- paste(noStopwordsCorpus, collapse = " ")                    object@.Data[[length(object)+1]] <- ID(data)
263                  }
264                  else
265                      object@.Data[[length(object)+1]] <- data
266                  DMetaData(object) <- rbind(DMetaData(object), c(MetaID = CMetaData(object)@NodeID, meta))
267                return(object)                return(object)
268            })            })
269    
270  setGeneric("tm_filter", function(object, ..., FUN = s.filter) standardGeneric("tm_filter"))  prescindMeta <- function(object, meta) {
271  setMethod("tm_filter",      df <- DMetaData(object)
           signature(object = "TextDocCol"),  
           function(object, ..., FUN = s.filter) {  
               object[tm_index(object, ..., FUN)]  
           })  
272    
273  setGeneric("tm_index", function(object, ..., FUN = s.filter) standardGeneric("tm_index"))      for (m in meta)
274  setMethod("tm_index",          df <- cbind(df, structure(data.frame(I(meta(object, tag = m, type = "local"))), names = m))
           signature(object = "TextDocCol"),  
           function(object, ..., FUN = s.filter) {  
               sapply(object, FUN, ..., GlobalMetaData = GlobalMetaData(object))  
           })  
275    
276  s.filter <- function(object, s, ..., GlobalMetaData) {      df
     b <- TRUE  
     for (tag in names(s)) {  
         if (tag %in% names(LocalMetaData(object))) {  
             b <- b && any(grep(s[[tag]], LocalMetaData(object)[[tag]]))  
         } else if (tag %in% names(GlobalMetaData)){  
             b <- b && any(grep(s[[tag]], GlobalMetaData[[tag]]))  
         } else {  
             b <- b && any(grep(s[[tag]], eval(call(tag, object))))  
         }  
     }  
     return(b)  
277  }  }
278    
279  setGeneric("fulltext.search.filter", function(object, pattern, ...) standardGeneric("fulltext.search.filter"))  setMethod("[",
280  setMethod("fulltext.search.filter",            signature(x = "PCorpus", i = "ANY", j = "ANY", drop = "ANY"),
281            signature(object = "PlainTextDocument", pattern = "character"),            function(x, i, j, ... , drop) {
282            function(object, pattern, ...) {                if (missing(i)) return(x)
               if (!Cached(object))  
                   object <- loadFileIntoMem(object)  
283    
284                return(any(grep(pattern, Corpus(object))))                x@.Data <- x@.Data[i, ..., drop = FALSE]
285                  index <- x@DMetaData[[1 , "subset"]]
286                  if (any(is.na(index))) x@DMetaData[[1 , "subset"]] <- i
287                  else x@DMetaData[[1 , "subset"]] <- index[i]
288                  x
289            })            })
290    
291  setGeneric("reuters21578.topic.filter", function(object, topics, ...) standardGeneric("reuters21578.topic.filter"))  setMethod("[",
292  setMethod("reuters21578.topic.filter",            signature(x = "SCorpus", i = "ANY", j = "ANY", drop = "ANY"),
293            signature(object = "PlainTextDocument", topics = "character"),            function(x, i, j, ... , drop) {
294            function(object, topics, ...) {                if (missing(i)) return(x)
               if (!Cached(object))  
                   object <- loadFileIntoMem(object)  
295    
296                if (any(LocalMetaData(object)$Topics %in% topics))                x@.Data <- x@.Data[i, ..., drop = FALSE]
297                    return(TRUE)                DMetaData(x) <- DMetaData(x)[i, , drop = FALSE]
298                else                x
                   return(FALSE)  
299            })            })
300    
301  setGeneric("id.filter", function(object, IDs, ...) standardGeneric("id.filter"))  setMethod("[<-",
302  setMethod("id.filter",            signature(x = "PCorpus", i = "ANY", j = "ANY", value = "ANY"),
303            signature(object = "TextDocument", IDs = "numeric"),            function(x, i, j, ... , value) {
304            function(object, IDs, ...) {                db <- filehash::dbInit(DBControl(x)[["dbName"]], DBControl(x)[["dbType"]])
305                if (ID(object) %in% IDs)                counter <- 1
306                    return(TRUE)                for (id in x@.Data[i, ...]) {
307                else                    if (identical(length(value), 1)) db[[id]] <- value
308                    return(FALSE)                    else db[[id]] <- value[[counter]]
309                      counter <- counter + 1
310                  }
311                  x
312              })
313    setMethod("[<-",
314              signature(x = "SCorpus", i = "ANY", j = "ANY", value = "ANY"),
315              function(x, i, j, ... , value) {
316                  x@.Data[i, ...] <- value
317                  x
318            })            })
319    
320  setGeneric("attachData", function(object, data) standardGeneric("attachData"))  setMethod("[[",
321  setMethod("attachData",            signature(x = "PCorpus", i = "ANY", j = "ANY"),
322            signature(object = "TextDocCol", data = "TextDocument"),            function(x, i, j, ...) {
323            function(object, data) {                db <- filehash::dbInit(DBControl(x)[["dbName"]], DBControl(x)[["dbType"]])
324                data <- as(list(data), "TextDocCol")                filehash::dbFetch(db, x@.Data[[i]])
325                object@.Data <- as(c(object@.Data, data), "TextDocCol")            })
326                return(object)  setMethod("[[",
327              signature(x = "SCorpus", i = "ANY", j = "ANY"),
328              function(x, i, j, ...) {
329                  # TODO: For which corpora should lazy mapping be available?
330                  lazyTmMap <- meta(x, tag = "lazyTmMap", type = "corpus")
331                  if (!is.null(lazyTmMap))
332                      .Call("copyCorpus", x, materialize(x, i))
333                  x@.Data[[i]]
334            })            })
335    
336  setGeneric("attachMetaData", function(object, name, metadata) standardGeneric("attachMetaData"))  setMethod("[[<-",
337  setMethod("attachMetaData",            signature(x = "PCorpus", i = "ANY", j = "ANY", value = "ANY"),
338            signature(object = "TextDocCol"),            function(x, i, j, ..., value) {
339            function(object, name, metadata) {                db <- filehash::dbInit(DBControl(x)[["dbName"]], DBControl(x)[["dbType"]])
340                object@GlobalMetaData <- c(GlobalMetaData(object), new = list(metadata))                index <- x@.Data[[i]]
341                names(object@GlobalMetaData)[length(names(GlobalMetaData(object)))] <- name                db[[index]] <- value
342                return(object)                x
343            })            })
344    setMethod("[[<-",
345              signature(x = "SCorpus", i = "ANY", j = "ANY", value = "ANY"),
346              function(x, i, j, ..., value) {
347                  # Mark new objects as not active for lazy mapping
348                  lazyTmMap <- meta(x, tag = "lazyTmMap", type = "corpus")
349                  if (!is.null(lazyTmMap)) {
350                      lazyTmMap$index[i] <- FALSE
351                      meta(x, tag = "lazyTmMap", type = "corpus") <- lazyTmMap
352                  }
353                  # Set the value
354                  x@.Data[[i, ...]] <- value
355    
356  setGeneric("setSubscriptable", function(object, name) standardGeneric("setSubscriptable"))                x
 setMethod("setSubscriptable",  
           signature(object = "TextDocCol"),  
           function(object, name) {  
               if (!is.character(GlobalMetaData(object)$subscriptable))  
                   object <- attachMetaData(object, "subscriptable", name)  
               else  
                   object@GlobalMetaData$subscriptable <- c(GlobalMetaData(object)$subscriptable, name)  
               return(object)  
357            })            })
358    
359  setMethod("[",  # Update \code{NodeID}s of a CMetaData tree
360            signature(x = "TextDocCol", i = "ANY", j = "ANY", drop = "ANY"),  update_id <- function(object, id = 0, mapping = NULL, left.mapping = NULL, level = 0) {
361            function(x, i, j, ... , drop) {      # Traversal of (binary) CMetaData tree with setup of \code{NodeID}s
362                if(missing(i))      set_id <- function(object) {
363                    return(x)          object@NodeID <- id
364            id <<- id + 1
365            level <<- level + 1
366    
367                object <- x          if (length(object@children) > 0) {
368                object@.Data <- x@.Data[i, ..., drop = FALSE]              mapping <<- cbind(mapping, c(object@children[[1]]@NodeID, id))
369                for (m in names(GlobalMetaData(object))) {              left <- set_id(object@children[[1]])
370                    if (m %in% GlobalMetaData(object)$subscriptable) {              if (level == 1) {
371                        object@GlobalMetaData[[m]] <- GlobalMetaData(object)[[m]][i, ..., drop = FALSE]                  left.mapping <<- mapping
372                    mapping <<- NULL
373                    }                    }
374                mapping <<- cbind(mapping, c(object@children[[2]]@NodeID, id))
375                right <- set_id(object@children[[2]])
376    
377                object@children <- list(left, right)
378                }                }
379            level <<- level - 1
380    
381                return(object)                return(object)
382            })      }
383    
384        return(list(root = set_id(object), left.mapping = left.mapping, right.mapping = mapping))
385    }
386    
387    # TODO: Implement concatenation for other corpus types
388  setMethod("c",  setMethod("c",
389            signature(x = "TextDocCol"),            signature(x = "Corpus"),
390            function(x, ..., recursive = TRUE){            function(x, ..., meta = list(merge_date = as.POSIXlt(Sys.time(), tz = "GMT"), merger = Sys.getenv("LOGNAME")), recursive = TRUE) {
391                args <- list(...)                args <- list(...)
392                if(length(args) == 0)                if(length(args) == 0)
393                    return(x)                    return(x)
394                return(as(c(as(x, "list"), ...), "TextDocCol"))  
395                  if (!all(sapply(args, inherits, "SCorpus")))
396                      stop("not all arguments are standard corpora")
397    
398                  Reduce(c2, base::c(list(x), args))
399      })      })
400    
401  setMethod("length",  setGeneric("c2", function(x, y, ..., meta = list(merge_date = as.POSIXlt(Sys.time(), tz = "GMT"), merger = Sys.getenv("LOGNAME")), recursive = TRUE) standardGeneric("c2"))
402            signature(x = "TextDocCol"),  setMethod("c2",
403            function(x){            signature(x = "SCorpus", y = "SCorpus"),
404                return(length(as(x, "list")))            function(x, y, ..., meta = list(merge_date = as.POSIXlt(Sys.time(), tz = "GMT"), merger = Sys.getenv("LOGNAME")), recursive = TRUE) {
405                  object <- x
406                  # Concatenate data slots
407                  object@.Data <- c(as(x, "list"), as(y, "list"))
408    
409                  # Update the CMetaData tree
410                  cmeta <- new("MetaDataNode", NodeID = 0, MetaData = meta, children = list(CMetaData(x), CMetaData(y)))
411                  update.struct <- update_id(cmeta)
412                  object@CMetaData <- update.struct$root
413    
414                  # Find indices to be updated for the left tree
415                  indices.mapping <- NULL
416                  for (m in levels(as.factor(DMetaData(x)$MetaID))) {
417                      indices <- (DMetaData(x)$MetaID == m)
418                      indices.mapping <- c(indices.mapping, list(m = indices))
419                      names(indices.mapping)[length(indices.mapping)] <- m
420                  }
421    
422                  # Update the DMetaData data frames for the left tree
423                  for (i in 1:ncol(update.struct$left.mapping)) {
424                      map <- update.struct$left.mapping[,i]
425                      x@DMetaData$MetaID <- replace(DMetaData(x)$MetaID, indices.mapping[[as.character(map[1])]], map[2])
426                  }
427    
428                  # Find indices to be updated for the right tree
429                  indices.mapping <- NULL
430                  for (m in levels(as.factor(DMetaData(y)$MetaID))) {
431                      indices <- (DMetaData(y)$MetaID == m)
432                      indices.mapping <- c(indices.mapping, list(m = indices))
433                      names(indices.mapping)[length(indices.mapping)] <- m
434                  }
435    
436                  # Update the DMetaData data frames for the right tree
437                  for (i in 1:ncol(update.struct$right.mapping)) {
438                      map <- update.struct$right.mapping[,i]
439                      y@DMetaData$MetaID <- replace(DMetaData(y)$MetaID, indices.mapping[[as.character(map[1])]], map[2])
440                  }
441    
442                  # Merge the DMetaData data frames
443                  labels <- setdiff(names(DMetaData(y)), names(DMetaData(x)))
444                  na.matrix <- matrix(NA, nrow = nrow(DMetaData(x)), ncol = length(labels), dimnames = list(row.names(DMetaData(x)), labels))
445                  x.dmeta.aug <- cbind(DMetaData(x), na.matrix)
446                  labels <- setdiff(names(DMetaData(x)), names(DMetaData(y)))
447                  na.matrix <- matrix(NA, nrow = nrow(DMetaData(y)), ncol = length(labels), dimnames = list(row.names(DMetaData(y)), labels))
448                  y.dmeta.aug <- cbind(DMetaData(y), na.matrix)
449                  object@DMetaData <- rbind(x.dmeta.aug, y.dmeta.aug)
450    
451                  return(object)
452              })
453    
454    setMethod("c",
455              signature(x = "TextDocument"),
456              function(x, ..., recursive = TRUE){
457                  args <- list(...)
458                  if (identical(length(args), 0)) return(x)
459    
460                  dmeta.df <- data.frame(MetaID = rep(0, length(list(x, ...))), stringsAsFactors = FALSE)
461                  cmeta.node <- new("MetaDataNode",
462                                NodeID = 0,
463                                MetaData = list(create_date = as.POSIXlt(Sys.time(), tz = "GMT"), creator = Sys.getenv("LOGNAME")),
464                                children = list())
465    
466                  new("SCorpus", .Data = list(x, ...), DMetaData = dmeta.df, CMetaData = cmeta.node)
467      })      })
468    
469  setMethod("show",  setMethod("show",
470            signature(object = "TextDocCol"),            signature(object = "Corpus"),
471            function(object){            function(object){
472                cat("A text document collection with", length(object), "text document")                cat(sprintf(ngettext(length(object),
473                if (length(object) == 1)                                     "A corpus with %d text document\n",
474                    cat("\n")                                     "A corpus with %d text documents\n"),
475                else                            length(object)))
                   cat("s\n")  
476      })      })
477    
478  setMethod("summary",  setMethod("summary",
479            signature(object = "TextDocCol"),            signature(object = "Corpus"),
480            function(object){            function(object){
481                show(object)                show(object)
482                if (length(GlobalMetaData(object)) > 0) {                if (length(DMetaData(object)) > 0) {
483                    cat("\nThe global metadata consists of", length(GlobalMetaData(object)), "tag-value pair")                    cat(sprintf(ngettext(length(CMetaData(object)@MetaData),
484                    if (length(GlobalMetaData(object)) == 1)                                                "\nThe metadata consists of %d tag-value pair and a data frame\n",
485                        cat(".\n")                                                "\nThe metadata consists of %d tag-value pairs and a data frame\n"),
486                    else                                         length(CMetaData(object)@MetaData)))
                       cat("s.\n")  
487                    cat("Available tags are:\n")                    cat("Available tags are:\n")
488                    cat(names(GlobalMetaData(object)), "\n")                    cat(strwrap(paste(names(CMetaData(object)@MetaData), collapse = " "), indent = 2, exdent = 2), "\n")
489                      cat("Available variables in the data frame are:\n")
490                      cat(strwrap(paste(names(DMetaData(object)), collapse = " "), indent = 2, exdent = 2), "\n")
491                }                }
492      })      })
493    
494  setGeneric("inspect", function(object) standardGeneric("inspect"))  inspect <- function(x) UseMethod("inspect", x)
495  setMethod("inspect",  inspect.PCorpus <- function(x) {
496            c("TextDocCol"),      summary(x)
497            function(object) {      cat("\n")
498                summary(object)      db <- filehash::dbInit(DBControl(x)[["dbName"]], DBControl(x)[["dbType"]])
499        show(filehash::dbMultiFetch(db, unlist(x)))
500    }
501    inspect.FCorpus <- inspect.SCorpus <- function(x) {
502        summary(x)
503                cat("\n")                cat("\n")
504                show(as(object, "list"))      print(noquote(lapply(x, identity)))
505    }
506    
507    # No metadata is checked
508    setGeneric("%IN%", function(x, y) standardGeneric("%IN%"))
509    setMethod("%IN%", signature(x = "TextDocument", y = "PCorpus"),
510              function(x, y) {
511                  db <- filehash::dbInit(DBControl(y)[["dbName"]], DBControl(y)[["dbType"]])
512                  any(sapply(y, function(x, z) {x %in% Content(z)}, x))
513              })
514    setMethod("%IN%", signature(x = "TextDocument", y = "SCorpus"),
515              function(x, y) x %in% y)
516    
517    setMethod("lapply",
518              signature(X = "SCorpus"),
519              function(X, FUN, ...) {
520                  lazyTmMap <- meta(X, tag = "lazyTmMap", type = "corpus")
521                  if (!is.null(lazyTmMap))
522                      .Call("copyCorpus", X, materialize(X))
523                  base::lapply(X, FUN, ...)
524              })
525    setMethod("lapply",
526              signature(X = "PCorpus"),
527              function(X, FUN, ...) {
528                  db <- filehash::dbInit(DBControl(X)[["dbName"]], DBControl(X)[["dbType"]])
529                  lapply(filehash::dbMultiFetch(db, unlist(X)), FUN, ...)
530              })
531    
532    setMethod("sapply",
533              signature(X = "SCorpus"),
534              function(X, FUN, ..., simplify = TRUE, USE.NAMES = TRUE) {
535                  lazyTmMap <- meta(X, tag = "lazyTmMap", type = "corpus")
536                  if (!is.null(lazyTmMap))
537                      .Call("copyCorpus", X, materialize(X))
538                  base::sapply(X, FUN, ...)
539              })
540    setMethod("sapply",
541              signature(X = "PCorpus"),
542              function(X, FUN, ..., simplify = TRUE, USE.NAMES = TRUE) {
543                  db <- filehash::dbInit(DBControl(X)[["dbName"]], DBControl(X)[["dbType"]])
544                  sapply(filehash::dbMultiFetch(db, unlist(X)), FUN, ...)
545              })
546    
547    setAs("list", "SCorpus", function(from) {
548        cmeta.node <- new("MetaDataNode",
549                          NodeID = 0,
550                          MetaData = list(create_date = as.POSIXlt(Sys.time(), tz = "GMT"), creator = Sys.getenv("LOGNAME")),
551                          children = list())
552        data <- list()
553        counter <- 1
554        for (f in from) {
555            doc <- new("PlainTextDocument",
556                       .Data = f,
557                       Author = "", DateTimeStamp = as.POSIXlt(Sys.time(), tz = "GMT"),
558                       Description = "", ID = as.character(counter),
559                       Origin = "", Heading = "", Language = "eng")
560            data <- c(data, list(doc))
561            counter <- counter + 1
562        }
563        new("SCorpus", .Data = data,
564            DMetaData = data.frame(MetaID = rep(0, length(from)), stringsAsFactors = FALSE),
565            CMetaData = cmeta.node)
566    })
567    
568    setGeneric("writeCorpus", function(object, path = ".", filenames = NULL) standardGeneric("writeCorpus"))
569    setMethod("writeCorpus",
570              signature(object = "Corpus"),
571              function(object, path = ".", filenames = NULL) {
572                  filenames <- file.path(path,
573                                         if (is.null(filenames)) sapply(object, function(x) sprintf("%s.txt", ID(x)))
574                                         else filenames)
575                  i <- 1
576                  for (o in object) {
577                      writeLines(asPlain(o), filenames[i])
578                      i <- i + 1
579                  }
580            })            })

Legend:
Removed from v.62  
changed lines
  Added in v.950

root@r-forge.r-project.org
ViewVC Help
Powered by ViewVC 1.0.0  
Thanks to:
Vienna University of Economics and Business Powered By FusionForge