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 55, Thu Sep 14 12:31:07 2006 UTC pkg/R/textdoccol.R revision 905, Sat Mar 21 10:13:08 2009 UTC
# Line 1  Line 1 
1  # Author: Ingo Feinerer  # Author: Ingo Feinerer
2    
3  setGeneric("TextDocCol", function(object, inputType = "CSV", stripWhiteSpace = FALSE, toLower = FALSE) standardGeneric("TextDocCol"))  # The "..." are additional arguments for the FunctionGenerator reader
4  setMethod("TextDocCol",  setGeneric("Corpus", function(object,
5            c("character"),                                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", "REUT21578_XML", "RIS"))  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                           filelist <- dir(object, pattern = ".csv", full.names = TRUE)                if (is.null(readerControl$reader))
15                           tdl <- sapply(filelist,                    readerControl$reader <- object@DefaultReader
16                                         function(file) {                if (is(readerControl$reader, "FunctionGenerator"))
17                                             m <- as.matrix(read.csv(file, header = FALSE))                    readerControl$reader <- readerControl$reader(...)
18                                             l <- vector("list", dim(m)[1])                if (is.null(readerControl$language))
19                                             for (i in 1:dim(m)[1]) {                    readerControl$language = "en_US"
20                                                 author <- ""                if (is.null(readerControl$load))
21                                                 datetimestamp <- date()                    readerControl$load = TRUE
22                                                 description <- ""  
23                                                 id <- as.integer(m[i,1])                if (dbControl$useDb && require("filehash")) {
24                                                 corpus <- as.character(m[i,2:dim(m)[2]])                    if (!dbCreate(dbControl$dbName, dbControl$dbType))
25                                                 if (stripWhiteSpace)                        stop("error in creating database")
26                                                     corpus <- gsub("[[:space:]]+", " ", corpus)                    db <- dbInit(dbControl$dbName, dbControl$dbType)
27                                                 if (toLower)                }
28                                                     corpus <- tolower(corpus)  
29                                                 origin <- "CSV"                # Allocate memory in advance if length is known
30                                                 heading <- ""                tdl <- if (object@Length > 0)
31                      vector("list", as.integer(object@Length))
32                                                 l[[i]] <- new("PlainTextDocument", .Data = corpus, Author = author, DateTimeStamp = datetimestamp,                else
33                                                               Description = description, ID = id, Origin = origin, Heading = heading)                    list()
34                                             }  
35                                             l                counter <- 1
36                                         })                while (!eoi(object)) {
37                           if (length(filelist) > 1)                    object <- stepNext(object)
38                               tdcl <- new("TextDocCol", .Data = unlist(tdl, recursive = FALSE))                    elem <- getElem(object)
39                           else                    # If there is no Load on Demand support
40                               tdcl <- new("TextDocCol", .Data = tdl)                    # we need to load the corpus into memory at startup
41                       },                    if (!object@LoDSupport)
42                       # Read in text documents in XML Reuters Corpus Volume 1 (RCV1) format                        readerControl$load <- TRUE
43                       # The first argument is a directory with the RCV1 XML files                    doc <- readerControl$reader(elem, readerControl$load, readerControl$language, as.character(counter))
44                       "RCV1" = {                    if (dbControl$useDb && require("filehash")) {
45                           filelist <- dir(object, pattern = ".xml", full.names = TRUE)                        dbInsert(db, ID(doc), doc)
46                           tdl <- sapply(filelist,                        if (object@Length > 0)
47                                         function(file) {                            tdl[[counter]] <- ID(doc)
48                                             tree <- xmlTreeParse(file)                        else
49                                             xmlApply(xmlRoot(tree), parseNewsItemPlain, stripWhiteSpace, toLower)                            tdl <- c(tdl, ID(doc))
50                                         })                    }
51                           if (length(filelist) > 1)                    else {
52                               tdcl <- new("TextDocCol", .Data = unlist(tdl, recursive = FALSE))                        if (object@Length > 0)
53                           else                            tdl[[counter]] <- doc
54                               tdcl <- new("TextDocCol", .Data = tdl)                        else
55                       },                            tdl <- c(tdl, list(doc))
56                       # Read in text documents in Reuters-21578 XML (not SGML) format                    }
57                       # Typically the first argument will be a directory where we can                    counter <- counter + 1
58                       # find the files reut2-000.xml ... reut2-021.xml                }
59                       "REUT21578" = {  
60                           filelist <- dir(object, pattern = ".xml", full.names = TRUE)                df <- data.frame(MetaID = rep(0, length(tdl)), stringsAsFactors = FALSE)
61                           tdl <- sapply(filelist,                if (dbControl$useDb && require("filehash")) {
62                                         function(file) {                    dbInsert(db, "DMetaData", df)
63                                             tree <- xmlTreeParse(file)                    dmeta.df <- data.frame(key = "DMetaData", subset = I(list(NA)))
64                                             xmlApply(xmlRoot(tree), parseReutersPlain, stripWhiteSpace, toLower)                }
65                                         })                else
66                           if (length(filelist) > 1)                    dmeta.df <- df
67                               tdcl <- new("TextDocCol", .Data = unlist(tdl, recursive = FALSE))  
68                           else                cmeta.node <- new("MetaDataNode",
69                               tdcl <- new("TextDocCol", .Data = tdl)                              NodeID = 0,
70                       },                              MetaData = list(create_date = as.POSIXlt(Sys.time(), tz = "GMT"), creator = Sys.getenv("LOGNAME")),
71                       "REUT21578_XML" = {                              children = list())
72                           filelist <- dir(object, pattern = ".xml", full.names = TRUE)  
73                           tdl <- sapply(filelist,                return(new("Corpus", .Data = tdl, DMetaData = dmeta.df, CMetaData = cmeta.node, DBControl = dbControl))
74                                         function(file) {            })
75                                             parseReutersXML(file)  
76                                         })  setGeneric("loadDoc", function(object, ...) standardGeneric("loadDoc"))
77                           tdcl <- new("TextDocCol", .Data = tdl)  setMethod("loadDoc",
78                       },            signature(object = "PlainTextDocument"),
79                       # Read in HTML documents as used by http://ris.bka.gv.at/vwgh            function(object, ...) {
80                       "RIS" = {                if (!Cached(object)) {
81                           filelist <- dir(object, pattern = ".html", full.names = TRUE)                    con <- eval(URI(object))
82                           tdl <- sapply(filelist,                    corpus <- readLines(con)
83                                         function(file) {                    close(con)
84                                             # Ignore warnings from misformed HTML documents                    Content(object) <- corpus
85                                             suppressWarnings(RISDoc <- parseRISPlain(file, stripWhiteSpace, toLower))                    Cached(object) <- TRUE
86                                             if (!is.null(RISDoc)) {                    return(object)
87                                                 l <- list()                } else {
88                                                 l[[length(l) + 1]] <- RISDoc                    return(object)
89                                                 l                }
90                                             }            })
91                                         })  setMethod("loadDoc",
92                           tdcl <- new("TextDocCol", .Data = tdl)            signature(object =  "XMLTextDocument"),
93                       })            function(object, ...) {
94                tdcl                if (!Cached(object) && require("XML")) {
95            })                    con <- eval(URI(object))
96                      corpus <- paste(readLines(con), "\n", collapse = "")
97  # Parse an Austrian RIS HTML document                    close(con)
98  parseRISPlain <- function(file, stripWhiteSpace = FALSE, toLower = FALSE) {                    doc <- xmlTreeParse(corpus, asText = TRUE)
     author <- ""  
     datetimestamp <- date()  
     description <- ""  
   
     tree <- htmlTreeParse(file)  
     htmlElem <- unlist(tree$children$html$children)  
   
     if (is.null(htmlElem))  
         stop(paste("Empty document", file, "cannot be processed."))  
   
     textElem <- htmlElem[which(regexpr("text.value", names(htmlElem)) > 0)]  
     names(textElem) <- NULL  
   
     corpus <- paste(textElem, collapse = " ")  
   
     year <- substring(corpus, regexpr("..../../", corpus), regexpr("..../../", corpus) + 3)  
     senat <- substring(corpus, regexpr("..../../", corpus) + 5, regexpr("..../../", corpus) + 6)  
     number <- substring(corpus, regexpr("..../../", corpus) + 8, regexpr("..../../", corpus) + 11)  
   
     id <- as.integer(paste(year, senat, number, sep = ""))  
   
     if (is.na(id))  
         stop(paste("Cannot extract 'Geschaeftszahl' out of malformed document", file))  
     origin <- ""  
   
     if (stripWhiteSpace)  
         corpus <- gsub("[[:space:]]+", " ", corpus)  
     if (toLower)  
         corpus <- tolower(corpus)  
   
     heading <- ""  
   
     new("PlainTextDocument", .Data = corpus, Author = author, DateTimeStamp = datetimestamp,  
         Description = description, ID = id, Origin = origin, Heading = heading)  
 }  
   
 # Parse a <newsitem></newsitem> element from a well-formed RCV1 XML file  
 parseNewsItemPlain <- function(node, stripWhiteSpace = FALSE, toLower = FALSE) {  
     author <- "Not yet implemented"  
     datetimestamp <- xmlAttrs(node)[["date"]]  
     description <- "Not yet implemented"  
     id <- as.integer(xmlAttrs(node)[["itemid"]])  
     origin <- "Reuters Corpus Volume 1 XML"  
     corpus <- unlist(xmlApply(node[["text"]], xmlValue), use.names = FALSE)  
   
     if (stripWhiteSpace)  
         corpus <- gsub("[[:space:]]+", " ", corpus)  
     if (toLower)  
         corpus <- tolower(corpus)  
   
     heading <- xmlValue(node[["title"]])  
   
     new("PlainTextDocument", .Data = corpus, Author = author, DateTimeStamp = datetimestamp,  
         Description = description, ID = id, Origin = origin, Heading = heading)  
 }  
   
 # Parse a <REUTERS></REUTERS> element from a well-formed Reuters-21578 XML file  
 parseReutersPlain <- function(node, stripWhiteSpace = FALSE, toLower = FALSE) {  
     # The <AUTHOR></AUTHOR> tag is unfortunately NOT obligatory!  
     if (!is.null(node[["TEXT"]][["AUTHOR"]]))  
         author <- xmlValue(node[["TEXT"]][["AUTHOR"]])  
     else  
         author <- ""  
   
     datetimestamp <- xmlValue(node[["DATE"]])  
     description <- ""  
     id <- as.integer(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 <- ""  
   
     if (stripWhiteSpace)  
         corpus <- gsub("[[:space:]]+", " ", corpus)  
     if (toLower)  
         corpus <- tolower(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 = 1, Author = author, DateTimeStamp = datetimestamp,  
         Description = description, ID = id, Origin = origin, Heading = heading, LocalMetaData = list(Topics = topics))  
 }  
   
 # Parse a <REUTERS></REUTERS> element from a well-formed Reuters-21578 XML file  
 parseReutersXML<- function(file) {  
     new("XMLTextDocument", FileName = file, Cached = 0, Author = "REUTERS", DateTimeStamp = date(),  
         Description = "Reuters21578 file containing several news articles", ID = as.integer(0),  
         Origin = "Reuters-21578 XML", Heading = "Reuters21578 news articles")  
 }  
   
 setGeneric("loadFileIntoMem", function(object) standardGeneric("loadFileIntoMem"))  
 setMethod("loadFileIntoMem",  
           c("XMLTextDocument"),  
           function(object) {  
               if (object@Cached == 0) {  
                   file <- object@FileName  
                   doc <- xmlTreeParse(file)  
99                    class(doc) <- "list"                    class(doc) <- "list"
100                    object@.Data <- doc                    Content(object) <- doc
101                    object@Cached <- 1                    Cached(object) <- TRUE
102                      return(object)
103                  } else {
104                      return(object)
105                  }
106              })
107    setMethod("loadDoc",
108              signature(object = "NewsgroupDocument"),
109              function(object, ...) {
110                  if (!Cached(object)) {
111                      con <- eval(URI(object))
112                      mail <- readLines(con)
113                      close(con)
114                      Cached(object) <- TRUE
115                      for (index in seq_along(mail)) {
116                          if (mail[index] == "")
117                              break
118                      }
119                      Content(object) <- mail[(index + 1):length(mail)]
120                    return(object)                    return(object)
121                } else {                } else {
122                    return(object)                    return(object)
123                }                }
124            })            })
125    setMethod("loadDoc",
126              signature(object = "StructuredTextDocument"),
127              function(object, ...) {
128                  if (!Cached(object)) {
129                      warning("load on demand not (yet) supported for StructuredTextDocuments")
130                      return(object)
131                  } else
132                      return(object)
133              })
134    
135  setGeneric("tm_transform", function(object, FUN, ...) standardGeneric("tm_transform"))  setGeneric("tmUpdate", function(object,
136  setMethod("tm_transform",                                  origin,
137            c("TextDocCol"),                                  readerControl = list(reader = origin@DefaultReader, language = "en_US", load = TRUE),
138            function(object, FUN, ...) {                                  ...) standardGeneric("tmUpdate"))
139                lapply(object, FUN, ..., GlobalMetaData = GlobalMetaData(object))  # Update is only supported for directories
140    # At the moment no other LoD devices are available anyway
141    setMethod("tmUpdate",
142              signature(object = "Corpus", origin = "DirSource"),
143              function(object, origin,
144                       readerControl = list(reader = origin@DefaultReader, language = "en_US", load = TRUE),
145                       ...) {
146                  if (is.null(readerControl$reader))
147                      readerControl$reader <- origin@DefaultReader
148                  if (is(readerControl$reader, "FunctionGenerator"))
149                      readerControl$reader <- readerControl$reader(...)
150                  if (is.null(readerControl$language))
151                      readerControl$language = "en_US"
152                  if (is.null(readerControl$load))
153                      readerControl$load = TRUE
154    
155                  object.filelist <- unlist(lapply(object, function(x) {summary(eval(URI(x)))$description}))
156                  new.files <- setdiff(origin@FileList, object.filelist)
157    
158                  for (filename in new.files) {
159                      encoding <- origin@Encoding
160                      elem <- list(content = readLines(filename, encoding = encoding),
161                                   uri = substitute(file(filename, encoding = encoding)))
162                      object <- appendElem(object, readerControl$reader(elem, readerControl$load, readerControl$language, filename))
163                  }
164    
165                  return(object)
166              })
167    
168    setGeneric("tmMap", function(object, FUN, ..., lazy = FALSE) standardGeneric("tmMap"))
169    setMethod("tmMap",
170              signature(object = "Corpus", FUN = "function"),
171              function(object, FUN, ..., lazy = FALSE) {
172                  result <- object
173                  # Note that text corpora are automatically loaded into memory via \code{[[}
174                  if (DBControl(object)[["useDb"]] && require("filehash")) {
175                      if (lazy)
176                          warning("lazy mapping is deactived when using database backend")
177                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
178                      i <- 1
179                      for (id in unlist(object)) {
180                          db[[id]] <- FUN(object[[i]], ..., DMetaData = DMetaData(object))
181                          i <- i + 1
182                      }
183                      # Suggested by Christian Buchta
184                      dbReorganize(db)
185                  }
186                  else {
187                      # Lazy mapping
188                      if (lazy) {
189                          lazyTmMap <- meta(object, tag = "lazyTmMap", type = "corpus")
190                          if (is.null(lazyTmMap)) {
191                              meta(result, tag = "lazyTmMap", type = "corpus") <-
192                                  list(index = rep(TRUE, length(result)),
193                                       maps = list(function(x, DMetaData) FUN(x, ..., DMetaData = DMetaData)))
194                          }
195                          else {
196                              lazyTmMap$maps <- c(lazyTmMap$maps, list(function(x, DMetaData) FUN(x, ..., DMetaData = DMetaData)))
197                              meta(result, tag = "lazyTmMap", type = "corpus") <- lazyTmMap
198                          }
199                      }
200                      else {
201                          result@.Data <- if (clusterAvailable())
202                              snow::parLapply(snow::getMPIcluster(), object, FUN, ..., DMetaData = DMetaData(object))
203                          else
204                              lapply(object, FUN, ..., DMetaData = DMetaData(object))
205                      }
206                  }
207                  return(result)
208            })            })
209    
210  setGeneric("toPlainTextDocument", function(object, FUN, ...) standardGeneric("toPlainTextDocument"))  # Materialize lazy mappings
211  setMethod("toPlainTextDocument",  # Improvements by Christian Buchta
212            c("PlainTextDocument"),  materialize <- function(corpus, range = seq_along(corpus)) {
213        lazyTmMap <- meta(corpus, tag = "lazyTmMap", type = "corpus")
214        if (!is.null(lazyTmMap)) {
215           # Make valid and lazy index
216           idx <- (seq_along(corpus) %in% range) & lazyTmMap$index
217           if (any(idx)) {
218               res <- lapply(corpus@.Data[idx], loadDoc)
219               for (m in lazyTmMap$maps)
220                   res <- lapply(res, m, DMetaData = DMetaData(corpus))
221               corpus@.Data[idx] <- res
222               lazyTmMap$index[idx] <- FALSE
223           }
224        }
225        # Clean up if everything is materialized
226        if (!any(lazyTmMap$index))
227            lazyTmMap <- NULL
228        meta(corpus, tag = "lazyTmMap", type = "corpus") <- lazyTmMap
229        return(corpus)
230    }
231    
232    setGeneric("asPlain", function(object, FUN, ...) standardGeneric("asPlain"))
233    setMethod("asPlain",
234              signature(object = "PlainTextDocument"),
235            function(object, FUN, ...) {            function(object, FUN, ...) {
236                return(object)                return(object)
237            })            })
238  setMethod("toPlainTextDocument",  setMethod("asPlain",
239            c("XMLTextDocument"),            signature(object = "XMLTextDocument"),
240            function(object, FUN, ...) {            function(object, FUN, ...) {
241                if (object@Cached == 0)                require("XML")
                   object <- loadFileIntoMem(object)  
242    
243                corpus <- object@.Data                corpus <- Content(object)
244    
245                # As XMLDocument is no native S4 class, restore valid information                # As XMLDocument is no native S4 class, restore valid information
246                class(corpus) <- "XMLDocument"                class(corpus) <- "XMLDocument"
247                names(corpus) <- c("doc","dtd")                names(corpus) <- c("doc","dtd")
248    
249                return(xmlApply(xmlRoot(corpus), FUN, ...))                return(FUN(xmlRoot(corpus), ...))
250            })            })
251    setMethod("asPlain",
252              signature(object = "Reuters21578Document"),
253              function(object, FUN, ...) {
254                  require("XML")
255    
256  setGeneric("stemTextDocument", function(object, ...) standardGeneric("stemTextDocument"))                FUN <- convertReut21578XMLPlain
257  setMethod("stemTextDocument",                corpus <- Content(object)
           c("PlainTextDocument"),  
           function(object) {  
               require(Rstem)  
               splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))  
               stemmedCorpus <- wordStem(splittedCorpus)  
               object@.Data <- paste(stemmedCorpus, collapse = " ")  
               return (object)  
           })  
258    
259  setGeneric("removeStopWords", function(object, stopwords, ...) standardGeneric("removeStopWords"))                # As XMLDocument is no native S4 class, restore valid information
260  setMethod("removeStopWords",                class(corpus) <- "XMLDocument"
261            c("PlainTextDocument", "character"),                names(corpus) <- c("doc","dtd")
           function(object, stopwords) {  
               require(Rstem)  
               splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))  
               noStopwordsCorpus <- splittedCorpus[!splittedCorpus %in% stopwords]  
               object@.Data <- paste(noStopwordsCorpus, collapse = " ")  
               return (object)  
           })  
262    
263  setGeneric("tm_filter", function(object, FUN, ...) standardGeneric("tm_filter"))                return(FUN(xmlRoot(corpus), ...))
264  setMethod("tm_filter",            })
265            c("TextDocCol"),  setMethod("asPlain",
266              signature(object = "RCV1Document"),
267            function(object, FUN, ...) {            function(object, FUN, ...) {
268                sapply(object, FUN, ..., GlobalMetaData = GlobalMetaData(object))                return(convertRCV1Plain(object, ...))
269              })
270    setMethod("asPlain",
271              signature(object = "NewsgroupDocument"),
272              function(object, FUN, ...) {
273                  new("PlainTextDocument", .Data = Content(object), Cached = TRUE, URI = NULL, Author = Author(object),
274                      DateTimeStamp = DateTimeStamp(object), Description = Description(object), ID = ID(object),
275                      Origin = Origin(object), Heading = Heading(object), Language = Language(object),
276                      LocalMetaData = LocalMetaData(object))
277              })
278    setMethod("asPlain",
279              signature(object = "StructuredTextDocument"),
280              function(object, FUN, ...) {
281                  new("PlainTextDocument", .Data = unlist(Content(object)), Cached = TRUE,
282                      URI = NULL, Author = Author(object), DateTimeStamp = DateTimeStamp(object),
283                      Description = Description(object), ID = ID(object), Origin = Origin(object),
284                      Heading = Heading(object), Language = Language(object),
285                      LocalMetaData = LocalMetaData(object))
286              })
287    
288    setGeneric("tmFilter", function(object, ..., FUN = searchFullText, doclevel = TRUE) standardGeneric("tmFilter"))
289    setMethod("tmFilter",
290              signature(object = "Corpus"),
291              function(object, ..., FUN = searchFullText, doclevel = TRUE) {
292                  if (!is.null(attr(FUN, "doclevel")))
293                      doclevel <- attr(FUN, "doclevel")
294                  if (doclevel) {
295                      if (clusterAvailable())
296                          return(object[snow::parSapply(snow::getMPIcluster(), object, FUN, ..., DMetaData = DMetaData(object))])
297                      else
298                          return(object[sapply(object, FUN, ..., DMetaData = DMetaData(object))])
299                  }
300                  else
301                      return(object[FUN(object, ...)])
302            })            })
303    
304  setGeneric("filterREUT21578Topics", function(object, topics, ...) standardGeneric("filterREUT21578Topics"))  setGeneric("tmIndex", function(object, ..., FUN = searchFullText, doclevel = TRUE) standardGeneric("tmIndex"))
305  setMethod("filterREUT21578Topics",  setMethod("tmIndex",
306            c("PlainTextDocument", "character"),            signature(object = "Corpus"),
307            function(object, topics) {            function(object, ..., FUN = searchFullText, doclevel = TRUE) {
308                if (object@Cached == 0)                if (!is.null(attr(FUN, "doclevel")))
309                    object <- loadFileIntoMem(object)                    doclevel <- attr(FUN, "doclevel")
310                  if (doclevel) {
311                if (any(object@LocalMetaData$Topics %in% topics))                    if (clusterAvailable())
312                    return(TRUE)                        return(snow::parSapply(snow::getMPIcluster(), object, FUN, ..., DMetaData = DMetaData(object)))
313                      else
314                          return(sapply(object, FUN, ..., DMetaData = DMetaData(object)))
315                  }
316                else                else
317                    return(FALSE)                    return(FUN(object, ...))
318            })            })
319    
320  setGeneric("filterIDs", function(object, IDs, ...) standardGeneric("filterIDs"))  setGeneric("appendElem", function(object, data, meta = NULL) standardGeneric("appendElem"))
321  setMethod("filterIDs",  setMethod("appendElem",
322            c("TextDocument", "numeric"),            signature(object = "Corpus", data = "TextDocument"),
323            function(object, IDs) {            function(object, data, meta = NULL) {
324                if (object@ID %in% IDs)                if (DBControl(object)[["useDb"]] && require("filehash")) {
325                    return(TRUE)                    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                else
332                    return(FALSE)                    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("attachData", function(object, data) standardGeneric("attachData"))  setGeneric("appendMeta", function(object, cmeta = NULL, dmeta = NULL) standardGeneric("appendMeta"))
338  setMethod("attachData",  setMethod("appendMeta",
339            c("TextDocCol","TextDocument"),            signature(object = "Corpus"),
340            function(object, data) {            function(object, cmeta = NULL, dmeta = NULL) {
341                data <- as(list(data), "TextDocCol")                object@CMetaData@MetaData <- c(CMetaData(object)@MetaData, cmeta)
342                object@.Data <- as(c(object@.Data, data), "TextDocCol")                if (!is.null(dmeta)) {
343                      DMetaData(object) <- cbind(DMetaData(object), eval(dmeta))
344                  }
345                return(object)                return(object)
346            })            })
347    
348  setGeneric("attachMetaData", function(object, name, metadata) standardGeneric("attachMetaData"))  setGeneric("removeMeta", function(object, cname = NULL, dname = NULL) standardGeneric("removeMeta"))
349  setMethod("attachMetaData",  setMethod("removeMeta",
350            c("TextDocCol"),            signature(object = "Corpus"),
351            function(object, name, metadata) {            function(object, cname = NULL, dname = NULL) {
352                object@GlobalMetaData <- c(object@GlobalMetaData, new = list(metadata))                if (!is.null(cname))
353                names(object@GlobalMetaData)[length(names(object@GlobalMetaData))] <- name                    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)                return(object)
357            })            })
358    
359  setGeneric("setSubscriptable", function(object, name) standardGeneric("setSubscriptable"))  setGeneric("prescindMeta", function(object, meta) standardGeneric("prescindMeta"))
360  setMethod("setSubscriptable",  setMethod("prescindMeta",
361            c("TextDocCol"),            signature(object = "Corpus", meta = "character"),
362            function(object, name) {            function(object, meta) {
363                if (!is.character(object@GlobalMetaData$subscriptable))                for (m in meta) {
364                    object <- attachMetaData(object, "subscriptable", name)                    if (m %in% c("Author", "DateTimeStamp", "Description", "ID", "Origin", "Heading", "Language")) {
365                else                        local.m <- lapply(object, m)
366                    object@GlobalMetaData$subscriptable <- c(object@GlobalMetaData$subscriptable, name)                        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)                return(object)
385            })            })
386    
387  setMethod("[",  setMethod("[",
388            signature(x = "TextDocCol", i = "ANY", j = "ANY", drop = "ANY"),            signature(x = "Corpus", i = "ANY", j = "ANY", drop = "ANY"),
389            function(x, i, j, ... , drop) {            function(x, i, j, ... , drop) {
390                if(missing(i))                if(missing(i))
391                    return(x)                    return(x)
392    
393                object <- x                object <- x
394                object@.Data <- x@.Data[i, ..., drop = FALSE]                object@.Data <- x@.Data[i, ..., drop = FALSE]
395                for (m in names(object@GlobalMetaData)) {                if (DBControl(object)[["useDb"]] && require("filehash")) {
396                    if (m %in% object@GlobalMetaData$subscriptable) {                    index <- object@DMetaData[[1 , "subset"]]
397                        object@GlobalMetaData[[m]] <- object@GlobalMetaData[[m]][i, ..., drop = FALSE]                    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"]] && require("filehash")) {
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"]] && require("filehash")) {
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"]] && require("filehash")) {
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 = as.POSIXlt(Sys.time(), tz = "GMT"), 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 corpora")
503                  if (DBControl(x)[["useDb"]] || any(unlist(sapply(args, DBControl)["useDb", ])))
504                      stop("concatenating corpora with activated database is not supported")
505    
506                  Reduce(c2, base::c(list(x), args))
507              })
508    
509    setGeneric("c2", function(x, y, ..., meta = list(merge_date = as.POSIXlt(Sys.time(), tz = "GMT"), merger = Sys.getenv("LOGNAME")), recursive = TRUE) standardGeneric("c2"))
510    setMethod("c2",
511              signature(x = "Corpus", y = "Corpus"),
512              function(x, y, ..., meta = list(merge_date = as.POSIXlt(Sys.time(), tz = "GMT"), merger = Sys.getenv("LOGNAME")), recursive = TRUE) {
513                  object <- x
514                  # Concatenate data slots
515                  object@.Data <- c(as(x, "list"), as(y, "list"))
516    
517                  # Set the DBControl slot
518                  object@DBControl <- list(useDb = FALSE, dbName = "", dbType = "DB1")
519    
520                  # Update the CMetaData tree
521                  cmeta <- new("MetaDataNode", NodeID = 0, MetaData = meta, children = list(CMetaData(x), CMetaData(y)))
522                  update.struct <- update_id(cmeta)
523                  object@CMetaData <- update.struct$root
524    
525                  # Find indices to be updated for the left tree
526                  indices.mapping <- NULL
527                  for (m in levels(as.factor(DMetaData(x)$MetaID))) {
528                      indices <- (DMetaData(x)$MetaID == m)
529                      indices.mapping <- c(indices.mapping, list(m = indices))
530                      names(indices.mapping)[length(indices.mapping)] <- m
531                  }
532    
533                  # Update the DMetaData data frames for the left tree
534                  for (i in 1:ncol(update.struct$left.mapping)) {
535                      map <- update.struct$left.mapping[,i]
536                      x@DMetaData$MetaID <- replace(DMetaData(x)$MetaID, indices.mapping[[as.character(map[1])]], map[2])
537                  }
538    
539                  # Find indices to be updated for the right tree
540                  indices.mapping <- NULL
541                  for (m in levels(as.factor(DMetaData(y)$MetaID))) {
542                      indices <- (DMetaData(y)$MetaID == m)
543                      indices.mapping <- c(indices.mapping, list(m = indices))
544                      names(indices.mapping)[length(indices.mapping)] <- m
545                  }
546    
547                  # Update the DMetaData data frames for the right tree
548                  for (i in 1:ncol(update.struct$right.mapping)) {
549                      map <- update.struct$right.mapping[,i]
550                      y@DMetaData$MetaID <- replace(DMetaData(y)$MetaID, indices.mapping[[as.character(map[1])]], map[2])
551                }                }
552    
553                  # Merge the DMetaData data frames
554                  labels <- setdiff(names(DMetaData(y)), names(DMetaData(x)))
555                  na.matrix <- matrix(NA, nrow = nrow(DMetaData(x)), ncol = length(labels), dimnames = list(row.names(DMetaData(x)), labels))
556                  x.dmeta.aug <- cbind(DMetaData(x), na.matrix)
557                  labels <- setdiff(names(DMetaData(x)), names(DMetaData(y)))
558                  na.matrix <- matrix(NA, nrow = nrow(DMetaData(y)), ncol = length(labels), dimnames = list(row.names(DMetaData(y)), labels))
559                  y.dmeta.aug <- cbind(DMetaData(y), na.matrix)
560                  object@DMetaData <- rbind(x.dmeta.aug, y.dmeta.aug)
561    
562                return(object)                return(object)
563            })            })
564    
565  setMethod("c",  setMethod("c",
566            signature(x = "TextDocCol"),            signature(x = "TextDocument"),
567            function(x, ..., recursive = TRUE){            function(x, ..., recursive = TRUE){
568                args <- list(...)                args <- list(...)
569                if(length(args) == 0)                if(length(args) == 0)
570                    return(x)                    return(x)
571                return(as(c(as(x, "list"), ...), "TextDocCol"))  
572                  dmeta.df <- data.frame(MetaID = rep(0, length(list(x, ...))), stringsAsFactors = FALSE)
573                  cmeta.node <- new("MetaDataNode",
574                                NodeID = 0,
575                                MetaData = list(create_date = as.POSIXlt(Sys.time(), tz = "GMT"), creator = Sys.getenv("LOGNAME")),
576                                children = list())
577    
578                  return(new("Corpus",
579                             .Data = list(x, ...),
580                             DMetaData = dmeta.df,
581                             CMetaData = cmeta.node,
582                             DBControl = list(useDb = FALSE, dbName = "", dbType = "DB1")))
583      })      })
584    
585  setMethod("length",  setMethod("length",
586            signature(x = "TextDocCol"),            signature(x = "Corpus"),
587            function(x){            function(x){
588                return(length(as(x, "list")))                return(length(as(x, "list")))
589      })      })
590    
591  setMethod("show",  setMethod("show",
592            signature(object = "TextDocCol"),            signature(object = "Corpus"),
593            function(object){            function(object){
594                cat("A text document collection with", length(object), "text document")                cat(sprintf(ngettext(length(object),
595                if (length(object) == 1)                                     "A corpus with %d text document\n",
596                    cat("\n")                                     "A corpus with %d text documents\n"),
597                else                            length(object)))
                   cat("s\n")  
598      })      })
599    
600  setMethod("summary",  setMethod("summary",
601            signature(object = "TextDocCol"),            signature(object = "Corpus"),
602            function(object){            function(object){
603                show(object)                show(object)
604                if (length(GlobalMetaData(object)) > 0) {                if (length(DMetaData(object)) > 0) {
605                    cat("\nThe global metadata consists of", length(GlobalMetaData(object)), "tag-value pair")                    cat(sprintf(ngettext(length(CMetaData(object)@MetaData),
606                    if (length(GlobalMetaData(object)) == 1)                                                "\nThe metadata consists of %d tag-value pair and a data frame\n",
607                        cat(".\n")                                                "\nThe metadata consists of %d tag-value pairs and a data frame\n"),
608                    else                                         length(CMetaData(object)@MetaData)))
                       cat("s.\n")  
609                    cat("Available tags are:\n")                    cat("Available tags are:\n")
610                    cat(names(GlobalMetaData(object)), "\n")                    cat(strwrap(paste(names(CMetaData(object)@MetaData), collapse = " "), indent = 2, exdent = 2), "\n")
611                      cat("Available variables in the data frame are:\n")
612                      cat(strwrap(paste(names(DMetaData(object)), collapse = " "), indent = 2, exdent = 2), "\n")
613                }                }
614      })      })
615    
616  setGeneric("inspect", function(object) standardGeneric("inspect"))  setGeneric("inspect", function(object) standardGeneric("inspect"))
617  setMethod("inspect",  setMethod("inspect",
618            c("TextDocCol"),            signature("Corpus"),
619            function(object) {            function(object) {
620                summary(object)                summary(object)
621                cat("\n")                cat("\n")
622                show(as(object, "list"))                if (DBControl(object)[["useDb"]] && require("filehash")) {
623                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
624                      show(dbMultiFetch(db, unlist(object)))
625                  }
626                  else
627                      print(noquote(lapply(object, identity)))
628              })
629    
630    # No metadata is checked
631    setGeneric("%IN%", function(x, y) standardGeneric("%IN%"))
632    setMethod("%IN%",
633              signature(x = "TextDocument", y = "Corpus"),
634              function(x, y) {
635                  if (DBControl(y)[["useDb"]] && require("filehash")) {
636                      db <- dbInit(DBControl(y)[["dbName"]], DBControl(y)[["dbType"]])
637                      result <- any(sapply(y, function(x, z) {x %in% Content(z)}, x))
638                  }
639                  else
640                      result <- x %in% y
641                  return(result)
642              })
643    
644    setMethod("lapply",
645              signature(X = "Corpus"),
646              function(X, FUN, ...) {
647                  if (DBControl(X)[["useDb"]] && require("filehash")) {
648                      db <- dbInit(DBControl(X)[["dbName"]], DBControl(X)[["dbType"]])
649                      result <- lapply(dbMultiFetch(db, unlist(X)), FUN, ...)
650                  }
651                  else {
652                      lazyTmMap <- meta(X, tag = "lazyTmMap", type = "corpus")
653                      if (!is.null(lazyTmMap))
654                          .Call("copyCorpus", X, materialize(X))
655                      result <- base::lapply(X, FUN, ...)
656                  }
657                  return(result)
658              })
659    
660    setMethod("sapply",
661              signature(X = "Corpus"),
662              function(X, FUN, ..., simplify = TRUE, USE.NAMES = TRUE) {
663                  if (DBControl(X)[["useDb"]] && require("filehash")) {
664                      db <- dbInit(DBControl(X)[["dbName"]], DBControl(X)[["dbType"]])
665                      result <- sapply(dbMultiFetch(db, unlist(X)), FUN, ...)
666                  }
667                  else {
668                      lazyTmMap <- meta(X, tag = "lazyTmMap", type = "corpus")
669                      if (!is.null(lazyTmMap))
670                          .Call("copyCorpus", X, materialize(X))
671                      result <- base::sapply(X, FUN, ...)
672                  }
673                  return(result)
674              })
675    
676    setAs("list", "Corpus", function(from) {
677        cmeta.node <- new("MetaDataNode",
678                          NodeID = 0,
679                          MetaData = list(create_date = as.POSIXlt(Sys.time(), tz = "GMT"), creator = Sys.getenv("LOGNAME")),
680                          children = list())
681        data <- list()
682        counter <- 1
683        for (f in from) {
684            doc <- new("PlainTextDocument",
685                       .Data = f, URI = NULL, Cached = TRUE,
686                       Author = "", DateTimeStamp = as.POSIXlt(Sys.time(), tz = "GMT"),
687                       Description = "", ID = as.character(counter),
688                       Origin = "", Heading = "", Language = "en_US")
689            data <- c(data, list(doc))
690            counter <- counter + 1
691        }
692        return(new("Corpus", .Data = data,
693                   DMetaData = data.frame(MetaID = rep(0, length(from)), stringsAsFactors = FALSE),
694                   CMetaData = cmeta.node,
695                   DBControl = dbControl <- list(useDb = FALSE, dbName = "", dbType = "DB1")))
696    })
697    
698    setGeneric("writeCorpus", function(object, path = ".", filenames = NULL) standardGeneric("writeCorpus"))
699    setMethod("writeCorpus",
700              signature(object = "Corpus"),
701              function(object, path = ".", filenames = NULL) {
702                  filenames <- file.path(path,
703                                         if (is.null(filenames)) sapply(object, function(x) sprintf("%s.txt", ID(x)))
704                                         else filenames)
705                  i <- 1
706                  for (o in object) {
707                      writeLines(asPlain(o), filenames[i])
708                      i <- i + 1
709                  }
710            })            })

Legend:
Removed from v.55  
changed lines
  Added in v.905

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