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/trunk/R/textdoccol.R revision 37, Wed Jan 11 17:49:17 2006 UTC pkg/R/textdoccol.R revision 909, Sun Mar 22 12:45:59 2009 UTC
# Line 1  Line 1 
1  # Author: Ingo Feinerer  # Author: Ingo Feinerer
2    
3  setGeneric("textdoccol", function(object, ...) standardGeneric("textdoccol"))  # The "..." are additional arguments for the FunctionGenerator reader
4  setMethod("textdoccol",  setGeneric("Corpus", function(object,
5            c("character", "character", "logical", "logical"),                                readerControl = list(reader = object@DefaultReader, language = "en_US", load = TRUE),
6            function(object, inputType = "CSV", stripWhiteSpace = FALSE, toLower = FALSE) {                                dbControl = list(useDb = FALSE, dbName = "", dbType = "DB1"),
7                # Add a new type for each unique input source format                                ...) standardGeneric("Corpus"))
8                type <- match.arg(inputType,c("CSV","RCV1","REUT21578"))  setMethod("Corpus",
9                switch(type,            signature(object = "Source"),
10                       # Text in a special CSV format            function(object,
11                       # For details on the file format see the R documentation file                     readerControl = list(reader = object@DefaultReader, language = "en_US", load = TRUE),
12                       # The first argument is a directory with .csv files                     dbControl = list(useDb = FALSE, dbName = "", dbType = "DB1"),
13                       "CSV" = {                     ...) {
14                           tdl <- sapply(dir(object,                if (is.null(readerControl$reader))
15                                             pattern = ".csv",                    readerControl$reader <- object@DefaultReader
16                                             full.names = TRUE),                if (is(readerControl$reader, "FunctionGenerator"))
17                                         function(file) {                    readerControl$reader <- readerControl$reader(...)
18                                             m <- as.matrix(read.csv(file, header = FALSE))                if (is.null(readerControl$language))
19                                             l <- vector("list", dim(m)[1])                    readerControl$language <- "en_US"
20                                             for (i in 1:dim(m)[1]) {                if (is.null(readerControl$load) || (!object@LoDSupport))
21                                                 author <- ""                    readerControl$load <- TRUE
22                                                 timestamp <- date()  
23                                                 description <- ""                if (dbControl$useDb && require("filehash")) {
24                                                 id <- as.integer(m[i,1])                    if (!dbCreate(dbControl$dbName, dbControl$dbType))
25                                                 corpus <- as.character(m[i,2:dim(m)[2]])                        stop("error in creating database")
26                                                 if (stripWhiteSpace)                    db <- dbInit(dbControl$dbName, dbControl$dbType)
27                                                     corpus <- gsub("[[:space:]]+", " ", corpus)                }
28                                                 if (toLower)  
29                                                     corpus <- tolower(corpus)                # Allocate memory in advance if length is known
30                                                 origin <- "CSV"                tdl <- if (object@Length > 0)
31                                                 heading <- ""                    vector("list", as.integer(object@Length))
32                  else
33                                                 l[[i]] <- new("textdocument", .Data = corpus, author = author, timestamp = timestamp,                    list()
34                                                               description = description, id = id, origin = origin, heading = heading)  
35                                             }                if ((!dbControl$useDb) && object@Vectorized)
36                                             l                    tdl <- lapply(mapply(c, pGetElem(object), id = seq_len(object@Length), SIMPLIFY = FALSE),
37                                         })                                  function(x) readerControl$reader(x[c("content", "uri")],
38                           tdcl <- new("textdoccol", .Data = tdl)                                                                   readerControl$load,
39                       },                                                                   readerControl$language,
40                       # Read in text documents in XML Reuters Corpus Volume 1 (RCV1) format                                                                   as.character(x$id)))
41                       # The first argument is a directory with the RCV1 XML files                else {
42                       "RCV1" = {                    counter <- 1
43                           tdl <- sapply(dir(object,                    while (!eoi(object)) {
44                                             pattern = ".xml",                        object <- stepNext(object)
45                                             full.names = TRUE),                        elem <- getElem(object)
46                                         function(file) {                        doc <- readerControl$reader(elem, readerControl$load, readerControl$language, as.character(counter))
47                                             tree <- xmlTreeParse(file)                        if (dbControl$useDb && require("filehash")) {
48                                             xmlApply(xmlRoot(tree), parseNewsItem, stripWhiteSpace, toLower)                            dbInsert(db, ID(doc), doc)
49                                         })                            if (object@Length > 0)
50                           tdcl <- new("textdoccol", .Data = tdl)                                tdl[[counter]] <- ID(doc)
51                       },                            else
52                       # Read in text documents in Reuters-21578 XML (not SGML) format                                tdl <- c(tdl, ID(doc))
53                       # Typically the first argument will be a directory where we can                        }
54                       # find the files reut2-000.xml ... reut2-021.xml                        else {
55                       "REUT21578" = {                            if (object@Length > 0)
56                           tdl <- sapply(dir(object,                                tdl[[counter]] <- doc
57                                             pattern = ".xml",                            else
58                                             full.names = TRUE),                                tdl <- c(tdl, list(doc))
59                                         function(file) {                        }
60                                             tree <- xmlTreeParse(file)                        counter <- counter + 1
61                                             xmlApply(xmlRoot(tree), parseReuters, stripWhiteSpace, toLower)                    }
62                                         })                }
63                           tdcl <- new("textdoccol", .Data = tdl)  
64                       })                df <- data.frame(MetaID = rep(0, length(tdl)), stringsAsFactors = FALSE)
65                tdcl                if (dbControl$useDb && require("filehash")) {
66            })                    dbInsert(db, "DMetaData", df)
67                      dmeta.df <- data.frame(key = "DMetaData", subset = I(list(NA)))
68  # TODO: Implement lacking fields as soon I have access to the original RCV1                }
69  # Parse a <newsitem></newsitem> element from a well-formed RCV1 XML file                else
70  parseNewsItem <- function(node, stripWhiteSpace = FALSE, toLower = FALSE) {                    dmeta.df <- df
71      author <- "Not yet implemented"  
72      timestamp <- xmlAttrs(node)[["date"]]                cmeta.node <- new("MetaDataNode",
73      description <- "Not yet implemented"                              NodeID = 0,
74      id <- as.integer(xmlAttrs(node)[["itemid"]])                              MetaData = list(create_date = as.POSIXlt(Sys.time(), tz = "GMT"), creator = Sys.getenv("LOGNAME")),
75      origin <- "Reuters Corpus Volume 1 XML"                              children = list())
76      corpus <- unlist(xmlApply(node[["text"]], xmlValue), use.names = FALSE)  
77                  return(new("Corpus", .Data = tdl, DMetaData = dmeta.df, CMetaData = cmeta.node, DBControl = dbControl))
78      if (stripWhiteSpace)            })
79          corpus <- gsub("[[:space:]]+", " ", corpus)  
80      if (toLower)  setGeneric("loadDoc", function(object, ...) standardGeneric("loadDoc"))
81          corpus <- tolower(corpus)  setMethod("loadDoc",
82              signature(object = "PlainTextDocument"),
83      heading <- xmlValue(node[["title"]])            function(object, ...) {
84                  if (!Cached(object)) {
85      new("textdocument", .Data = corpus, author = author, timestamp = timestamp,                    con <- eval(URI(object))
86          description = description, id = id, origin = origin, heading = heading)                    corpus <- readLines(con)
87  }                    close(con)
88                      Content(object) <- corpus
89  # Parse a <REUTERS></REUTERS> element from a well-formed Reuters-21578 XML file                    Cached(object) <- TRUE
90  parseReuters <- function(node, stripWhiteSpace = FALSE, toLower = FALSE) {                    return(object)
91      # The <AUTHOR></AUTHOR> tag is unfortunately NOT obligatory!                } else {
92      if (!is.null(node[["TEXT"]][["AUTHOR"]]))                    return(object)
93          author <- xmlValue(node[["TEXT"]][["AUTHOR"]])                }
94      else            })
95          author <- ""  setMethod("loadDoc",
96              signature(object =  "XMLTextDocument"),
97      timestamp <- xmlValue(node[["DATE"]])            function(object, ...) {
98      description <- ""                if (!Cached(object) && require("XML")) {
99      id <- as.integer(xmlAttrs(node)[["NEWID"]])                    con <- eval(URI(object))
100                      corpus <- paste(readLines(con), "\n", collapse = "")
101      origin <- "Reuters-21578 XML"                    close(con)
102                      doc <- xmlTreeParse(corpus, asText = TRUE)
103      # The <BODY></BODY> tag is unfortunately NOT obligatory!                    class(doc) <- "list"
104      if (!is.null(node[["TEXT"]][["BODY"]]))                    Content(object) <- doc
105          corpus <- xmlValue(node[["TEXT"]][["BODY"]])                    Cached(object) <- TRUE
106      else                    return(object)
107          corpus <- ""                } else {
108                      return(object)
109      if (stripWhiteSpace)                }
110          corpus <- gsub("[[:space:]]+", " ", corpus)            })
111      if (toLower)  setMethod("loadDoc",
112          corpus <- tolower(corpus)            signature(object = "NewsgroupDocument"),
113              function(object, ...) {
114      # The <TITLE></TITLE> tag is unfortunately NOT obligatory!                if (!Cached(object)) {
115      if (!is.null(node[["TEXT"]][["TITLE"]]))                    con <- eval(URI(object))
116          heading <- xmlValue(node[["TEXT"]][["TITLE"]])                    mail <- readLines(con)
117                      close(con)
118                      Cached(object) <- TRUE
119                      for (index in seq_along(mail)) {
120                          if (mail[index] == "")
121                              break
122                      }
123                      Content(object) <- mail[(index + 1):length(mail)]
124                      return(object)
125                  } else {
126                      return(object)
127                  }
128              })
129    setMethod("loadDoc",
130              signature(object = "StructuredTextDocument"),
131              function(object, ...) {
132                  if (!Cached(object)) {
133                      warning("load on demand not (yet) supported for StructuredTextDocuments")
134                      return(object)
135                  } else
136                      return(object)
137              })
138    
139    setGeneric("tmUpdate", function(object,
140                                    origin,
141                                    readerControl = list(reader = origin@DefaultReader, language = "en_US", load = TRUE),
142                                    ...) standardGeneric("tmUpdate"))
143    # Update is only supported for directories
144    # At the moment no other LoD devices are available anyway
145    setMethod("tmUpdate",
146              signature(object = "Corpus", origin = "DirSource"),
147              function(object, origin,
148                       readerControl = list(reader = origin@DefaultReader, language = "en_US", load = TRUE),
149                       ...) {
150                  if (is.null(readerControl$reader))
151                      readerControl$reader <- origin@DefaultReader
152                  if (is(readerControl$reader, "FunctionGenerator"))
153                      readerControl$reader <- readerControl$reader(...)
154                  if (is.null(readerControl$language))
155                      readerControl$language = "en_US"
156                  if (is.null(readerControl$load))
157                      readerControl$load = TRUE
158    
159                  object.filelist <- unlist(lapply(object, function(x) {summary(eval(URI(x)))$description}))
160                  new.files <- setdiff(origin@FileList, object.filelist)
161    
162                  for (filename in new.files) {
163                      encoding <- origin@Encoding
164                      elem <- list(content = readLines(filename, encoding = encoding),
165                                   uri = substitute(file(filename, encoding = encoding)))
166                      object <- appendElem(object, readerControl$reader(elem, readerControl$load, readerControl$language, filename))
167                  }
168    
169                  return(object)
170              })
171    
172    setGeneric("tmMap", function(object, FUN, ..., lazy = FALSE) standardGeneric("tmMap"))
173    setMethod("tmMap",
174              signature(object = "Corpus", FUN = "function"),
175              function(object, FUN, ..., lazy = FALSE) {
176                  result <- object
177                  # Note that text corpora are automatically loaded into memory via \code{[[}
178                  if (DBControl(object)[["useDb"]] && require("filehash")) {
179                      if (lazy)
180                          warning("lazy mapping is deactived when using database backend")
181                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
182                      i <- 1
183                      for (id in unlist(object)) {
184                          db[[id]] <- FUN(object[[i]], ..., DMetaData = DMetaData(object))
185                          i <- i + 1
186                      }
187                      # Suggested by Christian Buchta
188                      dbReorganize(db)
189                  }
190                  else {
191                      # Lazy mapping
192                      if (lazy) {
193                          lazyTmMap <- meta(object, tag = "lazyTmMap", type = "corpus")
194                          if (is.null(lazyTmMap)) {
195                              meta(result, tag = "lazyTmMap", type = "corpus") <-
196                                  list(index = rep(TRUE, length(result)),
197                                       maps = list(function(x, DMetaData) FUN(x, ..., DMetaData = DMetaData)))
198                          }
199                          else {
200                              lazyTmMap$maps <- c(lazyTmMap$maps, list(function(x, DMetaData) FUN(x, ..., DMetaData = DMetaData)))
201                              meta(result, tag = "lazyTmMap", type = "corpus") <- lazyTmMap
202                          }
203                      }
204                      else {
205                          result@.Data <- if (clusterAvailable())
206                              snow::parLapply(snow::getMPIcluster(), object, FUN, ..., DMetaData = DMetaData(object))
207                          else
208                              lapply(object, FUN, ..., DMetaData = DMetaData(object))
209                      }
210                  }
211                  return(result)
212              })
213    
214    # Materialize lazy mappings
215    # Improvements by Christian Buchta
216    materialize <- function(corpus, range = seq_along(corpus)) {
217        lazyTmMap <- meta(corpus, tag = "lazyTmMap", type = "corpus")
218        if (!is.null(lazyTmMap)) {
219           # Make valid and lazy index
220           idx <- (seq_along(corpus) %in% range) & lazyTmMap$index
221           if (any(idx)) {
222               res <- lapply(corpus@.Data[idx], loadDoc)
223               for (m in lazyTmMap$maps)
224                   res <- lapply(res, m, DMetaData = DMetaData(corpus))
225               corpus@.Data[idx] <- res
226               lazyTmMap$index[idx] <- FALSE
227           }
228        }
229        # Clean up if everything is materialized
230        if (!any(lazyTmMap$index))
231            lazyTmMap <- NULL
232        meta(corpus, tag = "lazyTmMap", type = "corpus") <- lazyTmMap
233        return(corpus)
234    }
235    
236    setGeneric("asPlain", function(object, FUN, ...) standardGeneric("asPlain"))
237    setMethod("asPlain",
238              signature(object = "PlainTextDocument"),
239              function(object, FUN, ...) {
240                  return(object)
241              })
242    setMethod("asPlain",
243              signature(object = "XMLTextDocument"),
244              function(object, FUN, ...) {
245                  require("XML")
246    
247                  corpus <- Content(object)
248    
249                  # As XMLDocument is no native S4 class, restore valid information
250                  class(corpus) <- "XMLDocument"
251                  names(corpus) <- c("doc","dtd")
252    
253                  return(FUN(xmlRoot(corpus), ...))
254              })
255    setMethod("asPlain",
256              signature(object = "Reuters21578Document"),
257              function(object, FUN, ...) {
258                  require("XML")
259    
260                  FUN <- convertReut21578XMLPlain
261                  corpus <- Content(object)
262    
263                  # As XMLDocument is no native S4 class, restore valid information
264                  class(corpus) <- "XMLDocument"
265                  names(corpus) <- c("doc","dtd")
266    
267                  return(FUN(xmlRoot(corpus), ...))
268              })
269    setMethod("asPlain",
270              signature(object = "RCV1Document"),
271              function(object, FUN, ...) {
272                  return(convertRCV1Plain(object, ...))
273              })
274    setMethod("asPlain",
275              signature(object = "NewsgroupDocument"),
276              function(object, FUN, ...) {
277                  new("PlainTextDocument", .Data = Content(object), Cached = TRUE, URI = NULL, Author = Author(object),
278                      DateTimeStamp = DateTimeStamp(object), Description = Description(object), ID = ID(object),
279                      Origin = Origin(object), Heading = Heading(object), Language = Language(object),
280                      LocalMetaData = LocalMetaData(object))
281              })
282    setMethod("asPlain",
283              signature(object = "StructuredTextDocument"),
284              function(object, FUN, ...) {
285                  new("PlainTextDocument", .Data = unlist(Content(object)), Cached = TRUE,
286                      URI = NULL, Author = Author(object), DateTimeStamp = DateTimeStamp(object),
287                      Description = Description(object), ID = ID(object), Origin = Origin(object),
288                      Heading = Heading(object), Language = Language(object),
289                      LocalMetaData = LocalMetaData(object))
290              })
291    
292    setGeneric("tmFilter", function(object, ..., FUN = searchFullText, doclevel = TRUE) standardGeneric("tmFilter"))
293    setMethod("tmFilter",
294              signature(object = "Corpus"),
295              function(object, ..., FUN = searchFullText, doclevel = TRUE) {
296                  if (!is.null(attr(FUN, "doclevel")))
297                      doclevel <- attr(FUN, "doclevel")
298                  if (doclevel) {
299                      if (clusterAvailable())
300                          return(object[snow::parSapply(snow::getMPIcluster(), object, FUN, ..., DMetaData = DMetaData(object))])
301                      else
302                          return(object[sapply(object, FUN, ..., DMetaData = DMetaData(object))])
303                  }
304      else      else
305          heading <- ""                    return(object[FUN(object, ...)])
306              })
307    
308      new("textdocument", .Data = corpus, author = author, timestamp = timestamp,  setGeneric("tmIndex", function(object, ..., FUN = searchFullText, doclevel = TRUE) standardGeneric("tmIndex"))
309          description = description, id = id, origin = origin, heading = heading)  setMethod("tmIndex",
310              signature(object = "Corpus"),
311              function(object, ..., FUN = searchFullText, doclevel = TRUE) {
312                  if (!is.null(attr(FUN, "doclevel")))
313                      doclevel <- attr(FUN, "doclevel")
314                  if (doclevel) {
315                      if (clusterAvailable())
316                          return(snow::parSapply(snow::getMPIcluster(), object, FUN, ..., DMetaData = DMetaData(object)))
317                      else
318                          return(sapply(object, FUN, ..., DMetaData = DMetaData(object)))
319                  }
320                  else
321                      return(FUN(object, ...))
322              })
323    
324    setGeneric("appendElem", function(object, data, meta = NULL) standardGeneric("appendElem"))
325    setMethod("appendElem",
326              signature(object = "Corpus", data = "TextDocument"),
327              function(object, data, meta = NULL) {
328                  if (DBControl(object)[["useDb"]] && require("filehash")) {
329                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
330                      if (dbExists(db, ID(data)))
331                          warning("document with identical ID already exists")
332                      dbInsert(db, ID(data), data)
333                      object@.Data[[length(object)+1]] <- ID(data)
334                  }
335                  else
336                      object@.Data[[length(object)+1]] <- data
337                  DMetaData(object) <- rbind(DMetaData(object), c(MetaID = CMetaData(object)@NodeID, meta))
338                  return(object)
339              })
340    
341    setGeneric("appendMeta", function(object, cmeta = NULL, dmeta = NULL) standardGeneric("appendMeta"))
342    setMethod("appendMeta",
343              signature(object = "Corpus"),
344              function(object, cmeta = NULL, dmeta = NULL) {
345                  object@CMetaData@MetaData <- c(CMetaData(object)@MetaData, cmeta)
346                  if (!is.null(dmeta)) {
347                      DMetaData(object) <- cbind(DMetaData(object), eval(dmeta))
348  }  }
349                  return(object)
350              })
351    
352    setGeneric("removeMeta", function(object, cname = NULL, dname = NULL) standardGeneric("removeMeta"))
353    setMethod("removeMeta",
354              signature(object = "Corpus"),
355              function(object, cname = NULL, dname = NULL) {
356                  if (!is.null(cname))
357                      object@CMetaData@MetaData <- CMetaData(object)@MetaData[names(CMetaData(object)@MetaData) != cname]
358                  if (!is.null(dname))
359                      DMetaData(object) <- DMetaData(object)[, names(DMetaData(object)) != dname, drop = FALSE]
360                  return(object)
361              })
362    
363    setGeneric("prescindMeta", function(object, meta) standardGeneric("prescindMeta"))
364    setMethod("prescindMeta",
365              signature(object = "Corpus", meta = "character"),
366              function(object, meta) {
367                  for (m in meta) {
368                      if (m %in% c("Author", "DateTimeStamp", "Description", "ID", "Origin", "Heading", "Language")) {
369                          local.m <- lapply(object, m)
370                          local.m <- sapply(local.m, paste, collapse = " ")
371                          local.m <- lapply(local.m, function(x) if (is.null(x)) return(NA) else return(x))
372                          local.m <- unlist(local.m)
373                          DMetaData(object) <- cbind(DMetaData(object), data.frame(m = local.m, stringsAsFactors = FALSE))
374                          names(DMetaData(object))[which(names(DMetaData(object)) == "m")] <- m
375                      }
376                      else {
377                          local.meta <- lapply(object, LocalMetaData)
378                          local.m <- lapply(local.meta, "[[", m)
379                          local.m <- lapply(local.m, function(x) if (is.null(x)) return(NA) else return(x))
380                          if (length(local.m) == length(unlist(local.m)))
381                              local.m <- unlist(local.m)
382                          else
383                              local.m <- I(local.m)
384                          DMetaData(object) <- cbind(DMetaData(object), data.frame(m = local.m, stringsAsFactors = FALSE))
385                          names(DMetaData(object))[which(names(DMetaData(object)) == "m")] <- m
386                      }
387                  }
388                  return(object)
389              })
390    
391    setMethod("[",
392              signature(x = "Corpus", i = "ANY", j = "ANY", drop = "ANY"),
393              function(x, i, j, ... , drop) {
394                  if(missing(i))
395                      return(x)
396    
397                  object <- x
398                  object@.Data <- x@.Data[i, ..., drop = FALSE]
399                  if (DBControl(object)[["useDb"]] && require("filehash")) {
400                      index <- object@DMetaData[[1 , "subset"]]
401                      if (any(is.na(index)))
402                          object@DMetaData[[1 , "subset"]] <- i
403                      else
404                          object@DMetaData[[1 , "subset"]] <- index[i]
405                  }
406                  else
407                      DMetaData(object) <- DMetaData(x)[i, , drop = FALSE]
408                  return(object)
409              })
410    
411    setMethod("[<-",
412              signature(x = "Corpus", i = "ANY", j = "ANY", value = "ANY"),
413              function(x, i, j, ... , value) {
414                  object <- x
415                  if (DBControl(object)[["useDb"]] && require("filehash")) {
416                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
417                      counter <- 1
418                      for (id in object@.Data[i, ...]) {
419                          if (length(value) == 1)
420                              db[[id]] <- value
421                          else {
422                              db[[id]] <- value[[counter]]
423                          }
424                          counter <- counter + 1
425                      }
426                  }
427                  else
428                      object@.Data[i, ...] <- value
429                  return(object)
430              })
431    
432    setMethod("[[",
433              signature(x = "Corpus", i = "ANY", j = "ANY"),
434              function(x, i, j, ...) {
435                  if (DBControl(x)[["useDb"]] && require("filehash")) {
436                      db <- dbInit(DBControl(x)[["dbName"]], DBControl(x)[["dbType"]])
437                      result <- dbFetch(db, x@.Data[[i]])
438                      return(loadDoc(result))
439                  }
440                  else {
441                      lazyTmMap <- meta(x, tag = "lazyTmMap", type = "corpus")
442                      if (!is.null(lazyTmMap))
443                          .Call("copyCorpus", x, materialize(x, i))
444                      return(loadDoc(x@.Data[[i]]))
445                  }
446              })
447    
448    setMethod("[[<-",
449              signature(x = "Corpus", i = "ANY", j = "ANY", value = "ANY"),
450              function(x, i, j, ..., value) {
451                  object <- x
452                  if (DBControl(object)[["useDb"]] && require("filehash")) {
453                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
454                      index <- object@.Data[[i]]
455                      db[[index]] <- value
456                  }
457                  else {
458                      # Mark new objects as not active for lazy mapping
459                      lazyTmMap <- meta(object, tag = "lazyTmMap", type = "corpus")
460                      if (!is.null(lazyTmMap)) {
461                          lazyTmMap$index[i] <- FALSE
462                          meta(object, tag = "lazyTmMap", type = "corpus") <- lazyTmMap
463                      }
464                      # Set the value
465                      object@.Data[[i, ...]] <- value
466                  }
467                  return(object)
468              })
469    
470    # Update \code{NodeID}s of a CMetaData tree
471    update_id <- function(object, id = 0, mapping = NULL, left.mapping = NULL, level = 0) {
472        # Traversal of (binary) CMetaData tree with setup of \code{NodeID}s
473        set_id <- function(object) {
474            object@NodeID <- id
475            id <<- id + 1
476            level <<- level + 1
477    
478            if (length(object@children) > 0) {
479                mapping <<- cbind(mapping, c(object@children[[1]]@NodeID, id))
480                left <- set_id(object@children[[1]])
481                if (level == 1) {
482                    left.mapping <<- mapping
483                    mapping <<- NULL
484                }
485                mapping <<- cbind(mapping, c(object@children[[2]]@NodeID, id))
486                right <- set_id(object@children[[2]])
487    
488                object@children <- list(left, right)
489            }
490            level <<- level - 1
491    
492            return(object)
493        }
494    
495        return(list(root = set_id(object), left.mapping = left.mapping, right.mapping = mapping))
496    }
497    
498    setMethod("c",
499              signature(x = "Corpus"),
500              function(x, ..., meta = list(merge_date = as.POSIXlt(Sys.time(), tz = "GMT"), merger = Sys.getenv("LOGNAME")), recursive = TRUE) {
501                  args <- list(...)
502                  if (length(args) == 0)
503                      return(x)
504    
505                  if (!all(sapply(args, inherits, "Corpus")))
506                      stop("not all arguments are corpora")
507                  if (DBControl(x)[["useDb"]] || any(unlist(sapply(args, DBControl)["useDb", ])))
508                      stop("concatenating corpora with activated database is not supported")
509    
510                  Reduce(c2, base::c(list(x), args))
511              })
512    
513    setGeneric("c2", function(x, y, ..., meta = list(merge_date = as.POSIXlt(Sys.time(), tz = "GMT"), merger = Sys.getenv("LOGNAME")), recursive = TRUE) standardGeneric("c2"))
514    setMethod("c2",
515              signature(x = "Corpus", y = "Corpus"),
516              function(x, y, ..., meta = list(merge_date = as.POSIXlt(Sys.time(), tz = "GMT"), merger = Sys.getenv("LOGNAME")), recursive = TRUE) {
517                  object <- x
518                  # Concatenate data slots
519                  object@.Data <- c(as(x, "list"), as(y, "list"))
520    
521                  # Set the DBControl slot
522                  object@DBControl <- list(useDb = FALSE, dbName = "", dbType = "DB1")
523    
524                  # Update the CMetaData tree
525                  cmeta <- new("MetaDataNode", NodeID = 0, MetaData = meta, children = list(CMetaData(x), CMetaData(y)))
526                  update.struct <- update_id(cmeta)
527                  object@CMetaData <- update.struct$root
528    
529                  # Find indices to be updated for the left tree
530                  indices.mapping <- NULL
531                  for (m in levels(as.factor(DMetaData(x)$MetaID))) {
532                      indices <- (DMetaData(x)$MetaID == m)
533                      indices.mapping <- c(indices.mapping, list(m = indices))
534                      names(indices.mapping)[length(indices.mapping)] <- m
535                  }
536    
537                  # Update the DMetaData data frames for the left tree
538                  for (i in 1:ncol(update.struct$left.mapping)) {
539                      map <- update.struct$left.mapping[,i]
540                      x@DMetaData$MetaID <- replace(DMetaData(x)$MetaID, indices.mapping[[as.character(map[1])]], map[2])
541                  }
542    
543                  # Find indices to be updated for the right tree
544                  indices.mapping <- NULL
545                  for (m in levels(as.factor(DMetaData(y)$MetaID))) {
546                      indices <- (DMetaData(y)$MetaID == m)
547                      indices.mapping <- c(indices.mapping, list(m = indices))
548                      names(indices.mapping)[length(indices.mapping)] <- m
549                  }
550    
551                  # Update the DMetaData data frames for the right tree
552                  for (i in 1:ncol(update.struct$right.mapping)) {
553                      map <- update.struct$right.mapping[,i]
554                      y@DMetaData$MetaID <- replace(DMetaData(y)$MetaID, indices.mapping[[as.character(map[1])]], map[2])
555                  }
556    
557                  # Merge the DMetaData data frames
558                  labels <- setdiff(names(DMetaData(y)), names(DMetaData(x)))
559                  na.matrix <- matrix(NA, nrow = nrow(DMetaData(x)), ncol = length(labels), dimnames = list(row.names(DMetaData(x)), labels))
560                  x.dmeta.aug <- cbind(DMetaData(x), na.matrix)
561                  labels <- setdiff(names(DMetaData(x)), names(DMetaData(y)))
562                  na.matrix <- matrix(NA, nrow = nrow(DMetaData(y)), ncol = length(labels), dimnames = list(row.names(DMetaData(y)), labels))
563                  y.dmeta.aug <- cbind(DMetaData(y), na.matrix)
564                  object@DMetaData <- rbind(x.dmeta.aug, y.dmeta.aug)
565    
566                  return(object)
567              })
568    
569    setMethod("c",
570              signature(x = "TextDocument"),
571              function(x, ..., recursive = TRUE){
572                  args <- list(...)
573                  if(length(args) == 0)
574                      return(x)
575    
576                  dmeta.df <- data.frame(MetaID = rep(0, length(list(x, ...))), stringsAsFactors = FALSE)
577                  cmeta.node <- new("MetaDataNode",
578                                NodeID = 0,
579                                MetaData = list(create_date = as.POSIXlt(Sys.time(), tz = "GMT"), creator = Sys.getenv("LOGNAME")),
580                                children = list())
581    
582                  return(new("Corpus",
583                             .Data = list(x, ...),
584                             DMetaData = dmeta.df,
585                             CMetaData = cmeta.node,
586                             DBControl = list(useDb = FALSE, dbName = "", dbType = "DB1")))
587              })
588    
589    setMethod("length",
590              signature(x = "Corpus"),
591              function(x){
592                  return(length(as(x, "list")))
593        })
594    
595    setMethod("show",
596              signature(object = "Corpus"),
597              function(object){
598                  cat(sprintf(ngettext(length(object),
599                                       "A corpus with %d text document\n",
600                                       "A corpus with %d text documents\n"),
601                              length(object)))
602        })
603    
604    setMethod("summary",
605              signature(object = "Corpus"),
606              function(object){
607                  show(object)
608                  if (length(DMetaData(object)) > 0) {
609                      cat(sprintf(ngettext(length(CMetaData(object)@MetaData),
610                                                  "\nThe metadata consists of %d tag-value pair and a data frame\n",
611                                                  "\nThe metadata consists of %d tag-value pairs and a data frame\n"),
612                                           length(CMetaData(object)@MetaData)))
613                      cat("Available tags are:\n")
614                      cat(strwrap(paste(names(CMetaData(object)@MetaData), collapse = " "), indent = 2, exdent = 2), "\n")
615                      cat("Available variables in the data frame are:\n")
616                      cat(strwrap(paste(names(DMetaData(object)), collapse = " "), indent = 2, exdent = 2), "\n")
617                  }
618        })
619    
620    setGeneric("inspect", function(object) standardGeneric("inspect"))
621    setMethod("inspect",
622              signature("Corpus"),
623              function(object) {
624                  summary(object)
625                  cat("\n")
626                  if (DBControl(object)[["useDb"]] && require("filehash")) {
627                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
628                      show(dbMultiFetch(db, unlist(object)))
629                  }
630                  else
631                      print(noquote(lapply(object, identity)))
632              })
633    
634    # No metadata is checked
635    setGeneric("%IN%", function(x, y) standardGeneric("%IN%"))
636    setMethod("%IN%",
637              signature(x = "TextDocument", y = "Corpus"),
638              function(x, y) {
639                  if (DBControl(y)[["useDb"]] && require("filehash")) {
640                      db <- dbInit(DBControl(y)[["dbName"]], DBControl(y)[["dbType"]])
641                      result <- any(sapply(y, function(x, z) {x %in% Content(z)}, x))
642                  }
643                  else
644                      result <- x %in% y
645                  return(result)
646              })
647    
648    setMethod("lapply",
649              signature(X = "Corpus"),
650              function(X, FUN, ...) {
651                  if (DBControl(X)[["useDb"]] && require("filehash")) {
652                      db <- dbInit(DBControl(X)[["dbName"]], DBControl(X)[["dbType"]])
653                      result <- lapply(dbMultiFetch(db, unlist(X)), FUN, ...)
654                  }
655                  else {
656                      lazyTmMap <- meta(X, tag = "lazyTmMap", type = "corpus")
657                      if (!is.null(lazyTmMap))
658                          .Call("copyCorpus", X, materialize(X))
659                      result <- base::lapply(X, FUN, ...)
660                  }
661                  return(result)
662              })
663    
664    setMethod("sapply",
665              signature(X = "Corpus"),
666              function(X, FUN, ..., simplify = TRUE, USE.NAMES = TRUE) {
667                  if (DBControl(X)[["useDb"]] && require("filehash")) {
668                      db <- dbInit(DBControl(X)[["dbName"]], DBControl(X)[["dbType"]])
669                      result <- sapply(dbMultiFetch(db, unlist(X)), FUN, ...)
670                  }
671                  else {
672                      lazyTmMap <- meta(X, tag = "lazyTmMap", type = "corpus")
673                      if (!is.null(lazyTmMap))
674                          .Call("copyCorpus", X, materialize(X))
675                      result <- base::sapply(X, FUN, ...)
676                  }
677                  return(result)
678              })
679    
680    setAs("list", "Corpus", function(from) {
681        cmeta.node <- new("MetaDataNode",
682                          NodeID = 0,
683                          MetaData = list(create_date = as.POSIXlt(Sys.time(), tz = "GMT"), creator = Sys.getenv("LOGNAME")),
684                          children = list())
685        data <- list()
686        counter <- 1
687        for (f in from) {
688            doc <- new("PlainTextDocument",
689                       .Data = f, URI = NULL, Cached = TRUE,
690                       Author = "", DateTimeStamp = as.POSIXlt(Sys.time(), tz = "GMT"),
691                       Description = "", ID = as.character(counter),
692                       Origin = "", Heading = "", Language = "en_US")
693            data <- c(data, list(doc))
694            counter <- counter + 1
695        }
696        return(new("Corpus", .Data = data,
697                   DMetaData = data.frame(MetaID = rep(0, length(from)), stringsAsFactors = FALSE),
698                   CMetaData = cmeta.node,
699                   DBControl = dbControl <- list(useDb = FALSE, dbName = "", dbType = "DB1")))
700    })
701    
702    setGeneric("writeCorpus", function(object, path = ".", filenames = NULL) standardGeneric("writeCorpus"))
703    setMethod("writeCorpus",
704              signature(object = "Corpus"),
705              function(object, path = ".", filenames = NULL) {
706                  filenames <- file.path(path,
707                                         if (is.null(filenames)) sapply(object, function(x) sprintf("%s.txt", ID(x)))
708                                         else filenames)
709                  i <- 1
710                  for (o in object) {
711                      writeLines(asPlain(o), filenames[i])
712                      i <- i + 1
713                  }
714              })

Legend:
Removed from v.37  
changed lines
  Added in v.909

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