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 trunk/tm/R/textdoccol.R revision 853, Sun May 18 13:09:35 2008 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))
21                                                 author <- ""                    readerControl$load = TRUE
22                                                 timestamp <- date()  
23                                                 description <- ""                if (dbControl$useDb) {
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)                tdl <- list()
30                                                 origin <- "CSV"                counter <- 1
31                                                 heading <- ""                while (!eoi(object)) {
32                      object <- stepNext(object)
33                                                 l[[i]] <- new("textdocument", .Data = corpus, author = author, timestamp = timestamp,                    elem <- getElem(object)
34                                                               description = description, id = id, origin = origin, heading = heading)                    # If there is no Load on Demand support
35                                             }                    # we need to load the corpus into memory at startup
36                                             l                    if (!object@LoDSupport)
37                                         })                        readerControl$load <- TRUE
38                           tdcl <- new("textdoccol", .Data = tdl)                    doc <- readerControl$reader(elem, readerControl$load, readerControl$language, as.character(counter))
39                       },                    if (dbControl$useDb) {
40                       # Read in text documents in XML Reuters Corpus Volume 1 (RCV1) format                        dbInsert(db, ID(doc), doc)
41                       # The first argument is a directory with the RCV1 XML files                        tdl <- c(tdl, ID(doc))
42                       "RCV1" = {                    }
43                           tdl <- sapply(dir(object,                    else
44                                             pattern = ".xml",                        tdl <- c(tdl, list(doc))
45                                             full.names = TRUE),                    counter <- counter + 1
46                                         function(file) {                }
47                                             tree <- xmlTreeParse(file)  
48                                             xmlApply(xmlRoot(tree), parseNewsItem, stripWhiteSpace, toLower)                df <- data.frame(MetaID = rep(0, length(tdl)), stringsAsFactors = FALSE)
49                                         })                if (dbControl$useDb) {
50                           tdcl <- new("textdoccol", .Data = tdl)                    dbInsert(db, "DMetaData", df)
51                       },                    dmeta.df <- data.frame(key = "DMetaData", subset = I(list(NA)))
52                       # Read in text documents in Reuters-21578 XML (not SGML) format                }
53                       # Typically the first argument will be a directory where we can                else
54                       # find the files reut2-000.xml ... reut2-021.xml                    dmeta.df <- df
55                       "REUT21578" = {  
56                           tdl <- sapply(dir(object,                cmeta.node <- new("MetaDataNode",
57                                             pattern = ".xml",                              NodeID = 0,
58                                             full.names = TRUE),                              MetaData = list(create_date = Sys.time(), creator = Sys.getenv("LOGNAME")),
59                                         function(file) {                              children = list())
60                                             tree <- xmlTreeParse(file)  
61                                             xmlApply(xmlRoot(tree), parseReuters, stripWhiteSpace, toLower)                return(new("Corpus", .Data = tdl, DMetaData = dmeta.df, CMetaData = cmeta.node, DBControl = dbControl))
62                                         })            })
63                           tdcl <- new("textdoccol", .Data = tdl)  
64                       })  setGeneric("loadDoc", function(object, ...) standardGeneric("loadDoc"))
65                tdcl  setMethod("loadDoc",
66            })            signature(object = "PlainTextDocument"),
67              function(object, ...) {
68  # TODO: Implement lacking fields as soon I have access to the original RCV1                if (!Cached(object)) {
69  # Parse a <newsitem></newsitem> element from a well-formed RCV1 XML file                    con <- eval(URI(object))
70  parseNewsItem <- function(node, stripWhiteSpace = FALSE, toLower = FALSE) {                    corpus <- readLines(con)
71      author <- "Not yet implemented"                    close(con)
72      timestamp <- xmlAttrs(node)[["date"]]                    Content(object) <- corpus
73      description <- "Not yet implemented"                    Cached(object) <- TRUE
74      id <- as.integer(xmlAttrs(node)[["itemid"]])                    return(object)
75      origin <- "Reuters Corpus Volume 1 XML"                } else {
76      corpus <- unlist(xmlApply(node[["text"]], xmlValue), use.names = FALSE)                    return(object)
77                  }
78      if (stripWhiteSpace)            })
79          corpus <- gsub("[[:space:]]+", " ", corpus)  setMethod("loadDoc",
80      if (toLower)            signature(object =  "XMLTextDocument"),
81          corpus <- tolower(corpus)            function(object, ...) {
82                  if (!Cached(object)) {
83      heading <- xmlValue(node[["title"]])                    con <- eval(URI(object))
84                      corpus <- paste(readLines(con), "\n", collapse = "")
85      new("textdocument", .Data = corpus, author = author, timestamp = timestamp,                    close(con)
86          description = description, id = id, origin = origin, heading = heading)                    doc <- xmlTreeParse(corpus, asText = TRUE)
87  }                    class(doc) <- "list"
88                      Content(object) <- doc
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 = "NewsgroupDocument"),
97      timestamp <- xmlValue(node[["DATE"]])            function(object, ...) {
98      description <- ""                if (!Cached(object)) {
99      id <- as.integer(xmlAttrs(node)[["NEWID"]])                    con <- eval(URI(object))
100                      mail <- readLines(con)
101      origin <- "Reuters-21578 XML"                    close(con)
102                      Cached(object) <- TRUE
103      # The <BODY></BODY> tag is unfortunately NOT obligatory!                    for (index in seq_along(mail)) {
104      if (!is.null(node[["TEXT"]][["BODY"]]))                        if (mail[index] == "")
105          corpus <- xmlValue(node[["TEXT"]][["BODY"]])                            break
106      else                    }
107          corpus <- ""                    Content(object) <- mail[(index + 1):length(mail)]
108                      return(object)
109      if (stripWhiteSpace)                } else {
110          corpus <- gsub("[[:space:]]+", " ", corpus)                    return(object)
111      if (toLower)                }
112          corpus <- tolower(corpus)            })
113    setMethod("loadDoc",
114      # The <TITLE></TITLE> tag is unfortunately NOT obligatory!            signature(object = "StructuredTextDocument"),
115      if (!is.null(node[["TEXT"]][["TITLE"]]))            function(object, ...) {
116          heading <- xmlValue(node[["TEXT"]][["TITLE"]])                if (!Cached(object)) {
117                      warning("load on demand not (yet) supported for StructuredTextDocuments")
118                      return(object)
119                  } else
120                      return(object)
121              })
122    
123    setGeneric("tmUpdate", function(object,
124                                    origin,
125                                    readerControl = list(reader = origin@DefaultReader, language = "en_US", load = TRUE),
126                                    ...) standardGeneric("tmUpdate"))
127    # Update is only supported for directories
128    # At the moment no other LoD devices are available anyway
129    setMethod("tmUpdate",
130              signature(object = "Corpus", origin = "DirSource"),
131              function(object, origin,
132                       readerControl = list(reader = origin@DefaultReader, language = "en_US", load = TRUE),
133                       ...) {
134                  if (is.null(readerControl$reader))
135                      readerControl$reader <- origin@DefaultReader
136                  if (is(readerControl$reader, "FunctionGenerator"))
137                      readerControl$reader <- readerControl$reader(...)
138                  if (is.null(readerControl$language))
139                      readerControl$language = "en_US"
140                  if (is.null(readerControl$load))
141                      readerControl$load = TRUE
142    
143                  object.filelist <- unlist(lapply(object, function(x) {as.character(URI(x))[2]}))
144                  new.files <- setdiff(origin@FileList, object.filelist)
145    
146                  for (filename in new.files) {
147                      encoding <- origin@Encoding
148                      elem <- list(content = readLines(filename, encoding = encoding),
149                                   uri = substitute(file(filename, encoding = encoding)))
150                      object <- appendElem(object, readerControl$reader(elem, readerControl$load, readerControl$language, filename))
151                  }
152    
153                  return(object)
154              })
155    
156    setGeneric("tmMap", function(object, FUN, ..., lazy = FALSE) standardGeneric("tmMap"))
157    setMethod("tmMap",
158              signature(object = "Corpus", FUN = "function"),
159              function(object, FUN, ..., lazy = FALSE) {
160                  result <- object
161                  # Note that text corpora are automatically loaded into memory via \code{[[}
162                  if (DBControl(object)[["useDb"]]) {
163                      if (lazy)
164                          warning("lazy mapping is deactived when using database backend")
165                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
166                      i <- 1
167                      for (id in unlist(object)) {
168                          db[[id]] <- FUN(object[[i]], ..., DMetaData = DMetaData(object))
169                          i <- i + 1
170                      }
171                      # Suggested by Christian Buchta
172                      dbReorganize(db)
173                  }
174                  else {
175                      # Lazy mapping
176                      if (lazy) {
177                          lazyTmMap <- meta(object, tag = "lazyTmMap", type = "corpus")
178                          if (is.null(lazyTmMap)) {
179                              meta(result, tag = "lazyTmMap", type = "corpus") <-
180                                  list(index = rep(TRUE, length(result)),
181                                       maps = list(function(x, DMetaData) FUN(x, ..., DMetaData = DMetaData)))
182                          }
183                          else {
184                              lazyTmMap$maps <- c(lazyTmMap$maps, list(function(x, DMetaData) FUN(x, ..., DMetaData = DMetaData)))
185                              meta(result, tag = "lazyTmMap", type = "corpus") <- lazyTmMap
186                          }
187                      }
188                      else
189                          result@.Data <- lapply(object, FUN, ..., DMetaData = DMetaData(object))
190                  }
191                  return(result)
192              })
193    
194    # Materialize lazy mappings
195    # Improvements by Christian Buchta
196    materialize <- function(corpus, range = seq_along(corpus)) {
197        lazyTmMap <- meta(corpus, tag = "lazyTmMap", type = "corpus")
198        if (!is.null(lazyTmMap)) {
199           # Make valid and lazy index
200           idx <- (seq_along(corpus) %in% range) & lazyTmMap$index
201           if (any(idx)) {
202               res <- lapply(corpus@.Data[idx], loadDoc)
203               for (m in lazyTmMap$maps)
204                   res <- lapply(res, m, DMetaData = DMetaData(corpus))
205               corpus@.Data[idx] <- res
206               lazyTmMap$index[idx] <- FALSE
207           }
208        }
209        # Clean up if everything is materialized
210        if (!any(lazyTmMap$index))
211            lazyTmMap <- NULL
212        meta(corpus, tag = "lazyTmMap", type = "corpus") <- lazyTmMap
213        return(corpus)
214    }
215    
216    setGeneric("asPlain", function(object, FUN, ...) standardGeneric("asPlain"))
217    setMethod("asPlain",
218              signature(object = "PlainTextDocument"),
219              function(object, FUN, ...) {
220                  return(object)
221              })
222    setMethod("asPlain",
223              signature(object = "XMLTextDocument", FUN = "function"),
224              function(object, FUN, ...) {
225                  corpus <- Content(object)
226    
227                  # As XMLDocument is no native S4 class, restore valid information
228                  class(corpus) <- "XMLDocument"
229                  names(corpus) <- c("doc","dtd")
230    
231                  return(FUN(xmlRoot(corpus), ...))
232              })
233    setMethod("asPlain",
234              signature(object = "Reuters21578Document"),
235              function(object, FUN, ...) {
236                  FUN <- convertReut21578XMLPlain
237                  corpus <- Content(object)
238    
239                  # As XMLDocument is no native S4 class, restore valid information
240                  class(corpus) <- "XMLDocument"
241                  names(corpus) <- c("doc","dtd")
242    
243                  return(FUN(xmlRoot(corpus), ...))
244              })
245    setMethod("asPlain",
246              signature(object = "RCV1Document"),
247              function(object, FUN, ...) {
248                  FUN <- convertRCV1Plain
249                  corpus <- Content(object)
250    
251                  # As XMLDocument is no native S4 class, restore valid information
252                  class(corpus) <- "XMLDocument"
253                  names(corpus) <- c("doc","dtd")
254    
255                  return(FUN(xmlRoot(corpus), ...))
256              })
257    setMethod("asPlain",
258              signature(object = "NewsgroupDocument"),
259              function(object, FUN, ...) {
260                  new("PlainTextDocument", .Data = Content(object), Cached = TRUE, URI = "", Author = Author(object),
261                      DateTimeStamp = DateTimeStamp(object), Description = Description(object), ID = ID(object),
262                      Origin = Origin(object), Heading = Heading(object), Language = Language(object),
263                      LocalMetaData = LocalMetaData(object))
264              })
265    setMethod("asPlain",
266              signature(object = "StructuredTextDocument"),
267              function(object, FUN, ...) {
268                  new("PlainTextDocument", .Data = unlist(Content(object)), Cached = TRUE,
269                      URI = "", Author = Author(object), DateTimeStamp = DateTimeStamp(object),
270                      Description = Description(object), ID = ID(object), Origin = Origin(object),
271                      Heading = Heading(object), Language = Language(object),
272                      LocalMetaData = LocalMetaData(object))
273              })
274    
275    setGeneric("tmFilter", function(object, ..., FUN = sFilter, doclevel = FALSE) standardGeneric("tmFilter"))
276    setMethod("tmFilter",
277              signature(object = "Corpus"),
278              function(object, ..., FUN = sFilter, doclevel = FALSE) {
279                  if (doclevel)
280                      return(object[sapply(object, FUN, ..., DMetaData = DMetaData(object))])
281                  else
282                      return(object[FUN(object, ...)])
283              })
284    
285    setGeneric("tmIndex", function(object, ..., FUN = sFilter, doclevel = FALSE) standardGeneric("tmIndex"))
286    setMethod("tmIndex",
287              signature(object = "Corpus"),
288              function(object, ..., FUN = sFilter, doclevel = FALSE) {
289                  if (doclevel)
290                      return(sapply(object, FUN, ..., DMetaData = DMetaData(object)))
291                  else
292                      return(FUN(object, ...))
293              })
294    
295    sFilter <- function(object, s, ...) {
296        con <- textConnection(s)
297        tokens <- scan(con, "character", quiet = TRUE)
298        close(con)
299        localMetaNames <- unique(names(sapply(object, LocalMetaData)))
300        localMetaTokens <- localMetaNames[localMetaNames %in% tokens]
301        n <- names(DMetaData(object))
302        tags <- c("Author", "DateTimeStamp", "Description", "ID", "Origin", "Heading", "Language", localMetaTokens)
303        query.df <- DMetaData(prescindMeta(object, tags))
304        if (DBControl(object)[["useDb"]])
305            DMetaData(object) <- DMetaData(object)[, setdiff(n, tags), drop = FALSE]
306        # Rename to avoid name conflicts
307        names(query.df)[names(query.df) == "Author"] <- "author"
308        names(query.df)[names(query.df) == "DateTimeStamp"] <- "datetimestamp"
309        names(query.df)[names(query.df) == "Description"] <- "description"
310        names(query.df)[names(query.df) == "ID"] <- "identifier"
311        names(query.df)[names(query.df) == "Origin"] <- "origin"
312        names(query.df)[names(query.df) == "Heading"] <- "heading"
313        names(query.df)[names(query.df) == "Language"] <- "language"
314        attach(query.df)
315        try(result <- rownames(query.df) %in% row.names(query.df[eval(parse(text = s)), ]))
316        detach(query.df)
317        return(result)
318    }
319    
320    setGeneric("appendElem", function(object, data, meta = NULL) standardGeneric("appendElem"))
321    setMethod("appendElem",
322              signature(object = "Corpus", data = "TextDocument"),
323              function(object, data, meta = NULL) {
324                  if (DBControl(object)[["useDb"]]) {
325                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
326                      if (dbExists(db, ID(data)))
327                          warning("document with identical ID already exists")
328                      dbInsert(db, ID(data), data)
329                      object@.Data[[length(object)+1]] <- ID(data)
330                  }
331                  else
332                      object@.Data[[length(object)+1]] <- data
333                  DMetaData(object) <- rbind(DMetaData(object), c(MetaID = CMetaData(object)@NodeID, meta))
334                  return(object)
335              })
336    
337    setGeneric("appendMeta", function(object, cmeta = NULL, dmeta = NULL) standardGeneric("appendMeta"))
338    setMethod("appendMeta",
339              signature(object = "Corpus"),
340              function(object, cmeta = NULL, dmeta = NULL) {
341                  object@CMetaData@MetaData <- c(CMetaData(object)@MetaData, cmeta)
342                  if (!is.null(dmeta)) {
343                      DMetaData(object) <- cbind(DMetaData(object), eval(dmeta))
344                  }
345                  return(object)
346              })
347    
348    setGeneric("removeMeta", function(object, cname = NULL, dname = NULL) standardGeneric("removeMeta"))
349    setMethod("removeMeta",
350              signature(object = "Corpus"),
351              function(object, cname = NULL, dname = NULL) {
352                  if (!is.null(cname))
353                      object@CMetaData@MetaData <- CMetaData(object)@MetaData[names(CMetaData(object)@MetaData) != cname]
354                  if (!is.null(dname))
355                      DMetaData(object) <- DMetaData(object)[, names(DMetaData(object)) != dname, drop = FALSE]
356                  return(object)
357              })
358    
359    setGeneric("prescindMeta", function(object, meta) standardGeneric("prescindMeta"))
360    setMethod("prescindMeta",
361              signature(object = "Corpus", meta = "character"),
362              function(object, meta) {
363                  for (m in meta) {
364                      if (m %in% c("Author", "DateTimeStamp", "Description", "ID", "Origin", "Heading", "Language")) {
365                          local.m <- lapply(object, m)
366                          local.m <- sapply(local.m, paste, collapse = " ")
367                          local.m <- lapply(local.m, function(x) if (is.null(x)) return(NA) else return(x))
368                          local.m <- unlist(local.m)
369                          DMetaData(object) <- cbind(DMetaData(object), data.frame(m = local.m, stringsAsFactors = FALSE))
370                          names(DMetaData(object))[which(names(DMetaData(object)) == "m")] <- m
371                      }
372                      else {
373                          local.meta <- lapply(object, LocalMetaData)
374                          local.m <- lapply(local.meta, "[[", m)
375                          local.m <- lapply(local.m, function(x) if (is.null(x)) return(NA) else return(x))
376                          if (length(local.m) == length(unlist(local.m)))
377                              local.m <- unlist(local.m)
378                          else
379                              local.m <- I(local.m)
380                          DMetaData(object) <- cbind(DMetaData(object), data.frame(m = local.m, stringsAsFactors = FALSE))
381                          names(DMetaData(object))[which(names(DMetaData(object)) == "m")] <- m
382                      }
383                  }
384                  return(object)
385              })
386    
387    setMethod("[",
388              signature(x = "Corpus", i = "ANY", j = "ANY", drop = "ANY"),
389              function(x, i, j, ... , drop) {
390                  if(missing(i))
391                      return(x)
392    
393                  object <- x
394                  object@.Data <- x@.Data[i, ..., drop = FALSE]
395                  if (DBControl(object)[["useDb"]]) {
396                      index <- object@DMetaData[[1 , "subset"]]
397                      if (any(is.na(index)))
398                          object@DMetaData[[1 , "subset"]] <- i
399                      else
400                          object@DMetaData[[1 , "subset"]] <- index[i]
401                  }
402                  else
403                      DMetaData(object) <- DMetaData(x)[i, , drop = FALSE]
404                  return(object)
405              })
406    
407    setMethod("[<-",
408              signature(x = "Corpus", i = "ANY", j = "ANY", value = "ANY"),
409              function(x, i, j, ... , value) {
410                  object <- x
411                  if (DBControl(object)[["useDb"]]) {
412                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
413                      counter <- 1
414                      for (id in object@.Data[i, ...]) {
415                          if (length(value) == 1)
416                              db[[id]] <- value
417                          else {
418                              db[[id]] <- value[[counter]]
419                          }
420                          counter <- counter + 1
421                      }
422                  }
423                  else
424                      object@.Data[i, ...] <- value
425                  return(object)
426              })
427    
428    setMethod("[[",
429              signature(x = "Corpus", i = "ANY", j = "ANY"),
430              function(x, i, j, ...) {
431                  if (DBControl(x)[["useDb"]]) {
432                      db <- dbInit(DBControl(x)[["dbName"]], DBControl(x)[["dbType"]])
433                      result <- dbFetch(db, x@.Data[[i]])
434                      return(loadDoc(result))
435                  }
436                  else {
437                      lazyTmMap <- meta(x, tag = "lazyTmMap", type = "corpus")
438                      if (!is.null(lazyTmMap))
439                          .Call("copyCorpus", x, materialize(x, i))
440                      return(loadDoc(x@.Data[[i]]))
441                  }
442              })
443    
444    setMethod("[[<-",
445              signature(x = "Corpus", i = "ANY", j = "ANY", value = "ANY"),
446              function(x, i, j, ..., value) {
447                  object <- x
448                  if (DBControl(object)[["useDb"]]) {
449                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
450                      index <- object@.Data[[i]]
451                      db[[index]] <- value
452                  }
453                  else {
454                      # Mark new objects as not active for lazy mapping
455                      lazyTmMap <- meta(object, tag = "lazyTmMap", type = "corpus")
456                      if (!is.null(lazyTmMap)) {
457                          lazyTmMap$index[i] <- FALSE
458                          meta(object, tag = "lazyTmMap", type = "corpus") <- lazyTmMap
459                      }
460                      # Set the value
461                      object@.Data[[i, ...]] <- value
462                  }
463                  return(object)
464              })
465    
466    # Update \code{NodeID}s of a CMetaData tree
467    update_id <- function(object, id = 0, mapping = NULL, left.mapping = NULL, level = 0) {
468        # Traversal of (binary) CMetaData tree with setup of \code{NodeID}s
469        set_id <- function(object) {
470            object@NodeID <- id
471            id <<- id + 1
472            level <<- level + 1
473    
474            if (length(object@children) > 0) {
475                mapping <<- cbind(mapping, c(object@children[[1]]@NodeID, id))
476                left <- set_id(object@children[[1]])
477                if (level == 1) {
478                    left.mapping <<- mapping
479                    mapping <<- NULL
480                }
481                mapping <<- cbind(mapping, c(object@children[[2]]@NodeID, id))
482                right <- set_id(object@children[[2]])
483    
484                object@children <- list(left, right)
485            }
486            level <<- level - 1
487    
488            return(object)
489        }
490    
491        return(list(root = set_id(object), left.mapping = left.mapping, right.mapping = mapping))
492    }
493    
494    setMethod("c",
495              signature(x = "Corpus"),
496              function(x, ..., meta = list(merge_date = Sys.time(), merger = Sys.getenv("LOGNAME")), recursive = TRUE) {
497                  args <- list(...)
498                  if (length(args) == 0)
499                      return(x)
500    
501                  if (!all(sapply(args, inherits, "Corpus")))
502                      stop("not all arguments are text document collections")
503                  if (DBControl(x)[["useDb"]] == TRUE || any(unlist(sapply(args, DBControl)["useDb", ])))
504                      stop("concatenating text document collections with activated database is not supported")
505    
506                  result <- x
507                  for (c in args) {
508                      result <- c2(result, c)
509                  }
510                  return(result)
511              })
512    
513    setGeneric("c2", function(x, y, ..., meta = list(merge_date = Sys.time(), 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 = Sys.time(), 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 = Sys.time(), 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 text document collection with %d text document\n",
600                                       "A text document collection 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"]]) {
627                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
628                      show(dbMultiFetch(db, unlist(object)))
629                  }
630      else      else
631          heading <- ""                    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"]]) {
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                  print("lapply")
652                  if (DBControl(X)[["useDb"]]) {
653                      db <- dbInit(DBControl(X)[["dbName"]], DBControl(X)[["dbType"]])
654                      result <- lapply(dbMultiFetch(db, unlist(X)), FUN, ...)
655                  }
656                  else {
657                      lazyTmMap <- meta(X, tag = "lazyTmMap", type = "corpus")
658                      if (!is.null(lazyTmMap))
659                          .Call("copyCorpus", X, materialize(X))
660                      result <- base::lapply(X, FUN, ...)
661                  }
662                  return(result)
663              })
664    
665      new("textdocument", .Data = corpus, author = author, timestamp = timestamp,  setMethod("sapply",
666          description = description, id = id, origin = origin, heading = heading)            signature(X = "Corpus"),
667              function(X, FUN, ..., simplify = TRUE, USE.NAMES = TRUE) {
668                  if (DBControl(X)[["useDb"]]) {
669                      db <- dbInit(DBControl(X)[["dbName"]], DBControl(X)[["dbType"]])
670                      result <- sapply(dbMultiFetch(db, unlist(X)), FUN, ...)
671  }  }
672                  else {
673                      lazyTmMap <- meta(X, tag = "lazyTmMap", type = "corpus")
674                      if (!is.null(lazyTmMap))
675                          .Call("copyCorpus", X, materialize(X))
676                      result <- base::sapply(X, FUN, ...)
677                  }
678                  return(result)
679              })
680    
681    setAs("list", "Corpus", function(from) {
682        cmeta.node <- new("MetaDataNode",
683                          NodeID = 0,
684                          MetaData = list(create_date = Sys.time(), creator = Sys.getenv("LOGNAME")),
685                          children = list())
686        data <- list()
687        counter <- 1
688        for (f in from) {
689            doc <- new("PlainTextDocument",
690                       .Data = f, URI = NULL, Cached = TRUE,
691                       Author = "", DateTimeStamp = Sys.time(),
692                       Description = "", ID = as.character(counter),
693                       Origin = "", Heading = "", Language = "en_US")
694            data <- c(data, list(doc))
695            counter <- counter + 1
696        }
697        return(new("Corpus", .Data = data,
698                   DMetaData = data.frame(MetaID = rep(0, length(from)), stringsAsFactors = FALSE),
699                   CMetaData = cmeta.node,
700                   DBControl = dbControl <- list(useDb = FALSE, dbName = "", dbType = "DB1")))
701    })
702    
703    setGeneric("writeCorpus", function(object, path = ".", filenames = NULL) standardGeneric("writeCorpus"))
704    setMethod("writeCorpus",
705              signature(object = "Corpus"),
706              function(object, path = ".", filenames = NULL) {
707                  filenames <- file.path(path,
708                                         if (is.null(filenames)) sapply(object, function(x) sprintf("%s.txt", ID(x)))
709                                         else filenames)
710                  i <- 1
711                  for (o in object) {
712                      writeLines(o, filenames[i])
713                      i <- i + 1
714                  }
715              })

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

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