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/corpus.R revision 1377, Wed May 21 17:15:56 2014 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"))  PCorpus <-
4  setMethod("TextDocCol",  function(x,
5            c("character"),           readerControl = list(reader = reader(x), language = "en"),
6            function(object, inputType = "CSV", stripWhiteSpace = FALSE, toLower = FALSE) {           dbControl = list(dbName = "", dbType = "DB1"))
7                # Add a new type for each unique input source format  {
8                type <- match.arg(inputType,c("CSV", "RCV1", "REUT21578", "REUT21578_XML", "RIS"))      stopifnot(inherits(x, "Source"))
9                switch(type,  
10                       # Text in a special CSV format      readerControl <- prepareReader(readerControl, reader(x))
11                       # For details on the file format see the R documentation file  
12                       # The first argument is a directory with .csv files      if (is.function(readerControl$init))
13                       "CSV" = {          readerControl$init()
14                           filelist <- dir(object, pattern = ".csv", full.names = TRUE)  
15                           tdl <- sapply(filelist,      if (is.function(readerControl$exit))
16                                         function(file) {          on.exit(readerControl$exit())
17                                             m <- as.matrix(read.csv(file, header = FALSE))  
18                                             l <- vector("list", dim(m)[1])      if (!filehash::dbCreate(dbControl$dbName, dbControl$dbType))
19                                             for (i in 1:dim(m)[1]) {          stop("error in creating database")
20                                                 author <- ""      db <- filehash::dbInit(dbControl$dbName, dbControl$dbType)
21                                                 datetimestamp <- date()  
22                                                 description <- ""      tdl <- vector("list", length(x))
23                                                 id <- as.integer(m[i,1])      counter <- 1
24                                                 corpus <- as.character(m[i,2:dim(m)[2]])      while (!eoi(x)) {
25                                                 if (stripWhiteSpace)          x <- stepNext(x)
26                                                     corpus <- gsub("[[:space:]]+", " ", corpus)          elem <- getElem(x)
27                                                 if (toLower)          doc <- readerControl$reader(elem,
28                                                     corpus <- tolower(corpus)                                      readerControl$language,
29                                                 origin <- "CSV"                                      as.character(counter))
30                                                 heading <- ""          filehash::dbInsert(db, meta(doc, "id"), doc)
31            tdl[[counter]] <- meta(doc, "id")
32                                                 l[[i]] <- new("PlainTextDocument", .Data = corpus, Author = author, DateTimeStamp = datetimestamp,          counter <- counter + 1
33                                                               Description = description, ID = id, Origin = origin, Heading = heading)      }
34                                             }  
35                                             l      structure(list(content = tdl,
36                                         })                     meta = CorpusMeta(),
37                           if (length(filelist) > 1)                     dmeta = data.frame(row.names = seq_along(tdl)),
38                               tdcl <- new("TextDocCol", .Data = unlist(tdl, recursive = FALSE))                     dbcontrol = dbControl),
39                           else                class = c("PCorpus", "Corpus"))
40                               tdcl <- new("TextDocCol", .Data = tdl)  }
41                       },  
42                       # Read in text documents in XML Reuters Corpus Volume 1 (RCV1) format  Corpus <-
43                       # The first argument is a directory with the RCV1 XML files  VCorpus <-
44                       "RCV1" = {  function(x, readerControl = list(reader = reader(x), language = "en"))
45                           filelist <- dir(object, pattern = ".xml", full.names = TRUE)  {
46                           tdl <- sapply(filelist,      stopifnot(inherits(x, "Source"))
47                                         function(file) {  
48                                             tree <- xmlTreeParse(file)      readerControl <- prepareReader(readerControl, reader(x))
49                                             xmlApply(xmlRoot(tree), parseNewsItemPlain, stripWhiteSpace, toLower)  
50                                         })      if (is.function(readerControl$init))
51                           if (length(filelist) > 1)          readerControl$init()
52                               tdcl <- new("TextDocCol", .Data = unlist(tdl, recursive = FALSE))  
53                           else      if (is.function(readerControl$exit))
54                               tdcl <- new("TextDocCol", .Data = tdl)          on.exit(readerControl$exit())
55                       },  
56                       # Read in text documents in Reuters-21578 XML (not SGML) format      tdl <- vector("list", length(x))
57                       # Typically the first argument will be a directory where we can      # Check for parallel element access
58                       # find the files reut2-000.xml ... reut2-021.xml      if (is.function(getS3method("pGetElem", class(x), TRUE)))
59                       "REUT21578" = {          tdl <- mapply(function(elem, id)
60                           filelist <- dir(object, pattern = ".xml", full.names = TRUE)                            readerControl$reader(elem, readerControl$language, id),
61                           tdl <- sapply(filelist,                        pGetElem(x),
62                                         function(file) {                        id = as.character(seq_along(x)),
63                                             tree <- xmlTreeParse(file)                        SIMPLIFY = FALSE)
64                                             xmlApply(xmlRoot(tree), parseReutersPlain, stripWhiteSpace, toLower)      else {
65                                         })          counter <- 1
66                           if (length(filelist) > 1)          while (!eoi(x)) {
67                               tdcl <- new("TextDocCol", .Data = unlist(tdl, recursive = FALSE))              x <- stepNext(x)
68                           else              elem <- getElem(x)
69                               tdcl <- new("TextDocCol", .Data = tdl)              doc <- readerControl$reader(elem,
70                       },                                          readerControl$language,
71                       "REUT21578_XML" = {                                          as.character(counter))
72                           filelist <- dir(object, pattern = ".xml", full.names = TRUE)              tdl[[counter]] <- doc
73                           tdl <- sapply(filelist,              counter <- counter + 1
74                                         function(file) {          }
75                                             parseReutersXML(file)      }
76                                         })  
77                           tdcl <- new("TextDocCol", .Data = tdl)      structure(list(content = tdl,
78                       },                     meta = CorpusMeta(),
79                       # Read in HTML documents as used by http://ris.bka.gv.at/vwgh                     dmeta = data.frame(row.names = seq_along(tdl))),
80                       "RIS" = {                class = c("VCorpus", "Corpus"))
81                           filelist <- dir(object, pattern = ".html", full.names = TRUE)  }
82                           tdl <- sapply(filelist,  
83                                         function(file) {  `[.PCorpus` <-
84                                             # Ignore warnings from misformed HTML documents  function(x, i)
85                                             suppressWarnings(RISDoc <- parseRISPlain(file, stripWhiteSpace, toLower))  {
86                                             if (!is.null(RISDoc)) {      if (!missing(i)) {
87                                                 l <- list()          x$content <- x$content[i]
88                                                 l[[length(l) + 1]] <- RISDoc          x$dmeta <- x$dmeta[i, , drop = FALSE]
89                                                 l      }
90                                             }      x
91                                         })  }
92                           tdcl <- new("TextDocCol", .Data = tdl)  
93                       })  `[.VCorpus` <-
94                tdcl  function(x, i)
95            })  {
96        if (!missing(i)) {
97  # Parse an Austrian RIS HTML document          x$content <- x$content[i]
98  parseRISPlain <- function(file, stripWhiteSpace = FALSE, toLower = FALSE) {          x$dmeta <- x$dmeta[i, , drop = FALSE]
99      author <- ""          if (!is.null(x$lazy))
100      datetimestamp <- date()              x$lazy$index <- x$lazy$index[i]
101      description <- ""      }
102        x
103      tree <- htmlTreeParse(file)  }
104      htmlElem <- unlist(tree$children$html$children)  
105    .map_name_index <-
106      if (is.null(htmlElem))  function(x, i)
107          stop(paste("Empty document", file, "cannot be processed."))  {
108        if (is.character(i))
109      textElem <- htmlElem[which(regexpr("text.value", names(htmlElem)) > 0)]          match(i, meta(x, "id", "local"))
110      names(textElem) <- NULL      else
111            i
112      corpus <- paste(textElem, collapse = " ")  }
113    
114      year <- substring(corpus, regexpr("..../../", corpus), regexpr("..../../", corpus) + 3)  `[[.PCorpus` <-
115      senat <- substring(corpus, regexpr("..../../", corpus) + 5, regexpr("..../../", corpus) + 6)  function(x, i)
116      number <- substring(corpus, regexpr("..../../", corpus) + 8, regexpr("..../../", corpus) + 11)  {
117        i <- .map_name_index(x, i)
118      id <- as.integer(paste(year, senat, number, sep = ""))      db <- filehash::dbInit(x$dbcontrol[["dbName"]], x$dbcontrol[["dbType"]])
119        filehash::dbFetch(db, x$content[[i]])
120      if (is.na(id))  }
121          stop(paste("Cannot extract 'Geschaeftszahl' out of malformed document", file))  `[[.VCorpus` <-
122      origin <- ""  function(x, i)
123    {
124      if (stripWhiteSpace)      i <- .map_name_index(x, i)
125          corpus <- gsub("[[:space:]]+", " ", corpus)      if (!is.null(x$lazy))
126      if (toLower)          .Call(copyCorpus, x, materialize(x, i))
127          corpus <- tolower(corpus)      x$content[[i]]
128    }
129      heading <- ""  
130    `[[<-.PCorpus` <-
131      new("PlainTextDocument", .Data = corpus, Author = author, DateTimeStamp = datetimestamp,  function(x, i, value)
132          Description = description, ID = id, Origin = origin, Heading = heading)  {
133  }      i <- .map_name_index(x, i)
134        db <- filehash::dbInit(x$dbcontrol[["dbName"]], x$dbcontrol[["dbType"]])
135  # Parse a <newsitem></newsitem> element from a well-formed RCV1 XML file      db[[x$content[[i]]]] <- value
136  parseNewsItemPlain <- function(node, stripWhiteSpace = FALSE, toLower = FALSE) {      x
137      author <- "Not yet implemented"  }
138      datetimestamp <- xmlAttrs(node)[["date"]]  `[[<-.VCorpus` <-
139      description <- "Not yet implemented"  function(x, i, value)
140      id <- as.integer(xmlAttrs(node)[["itemid"]])  {
141      origin <- "Reuters Corpus Volume 1 XML"      i <- .map_name_index(x, i)
142      corpus <- unlist(xmlApply(node[["text"]], xmlValue), use.names = FALSE)      # Mark new objects as inactive for lazy mapping
143        if (!is.null(x$lazy))
144      if (stripWhiteSpace)          x$lazy$index[i] <- FALSE
145          corpus <- gsub("[[:space:]]+", " ", corpus)      x$content[[i]] <- value
146      if (toLower)      x
147          corpus <- tolower(corpus)  }
148    
149      heading <- xmlValue(node[["title"]])  as.list.PCorpus <- as.list.VCorpus <-
150    function(x, ...)
151      new("PlainTextDocument", .Data = corpus, Author = author, DateTimeStamp = datetimestamp,      content(x)
152          Description = description, ID = id, Origin = origin, Heading = heading)  
153  }  as.VCorpus <-
154    function(x)
155  # Parse a <REUTERS></REUTERS> element from a well-formed Reuters-21578 XML file      UseMethod("as.VCorpus")
156  parseReutersPlain <- function(node, stripWhiteSpace = FALSE, toLower = FALSE) {  as.VCorpus.VCorpus <- identity
157      # The <AUTHOR></AUTHOR> tag is unfortunately NOT obligatory!  
158      if (!is.null(node[["TEXT"]][["AUTHOR"]]))  outer_union <-
159          author <- xmlValue(node[["TEXT"]][["AUTHOR"]])  function(x, y, ...)
160      else  {
161          author <- ""      if (nrow(x) > 0L)
162            x[, setdiff(names(y), names(x))] <- NA
163      datetimestamp <- xmlValue(node[["DATE"]])      if (nrow(y) > 0L)
164      description <- ""          y[, setdiff(names(x), names(y))] <- NA
165      id <- as.integer(xmlAttrs(node)[["NEWID"]])      res <- rbind(x, y)
166        if (ncol(res) == 0L)
167      origin <- "Reuters-21578 XML"          res <- data.frame(row.names = seq_len(nrow(x) + nrow(y)))
168        res
169      # The <BODY></BODY> tag is unfortunately NOT obligatory!  }
170      if (!is.null(node[["TEXT"]][["BODY"]]))  
171          corpus <- xmlValue(node[["TEXT"]][["BODY"]])  c.VCorpus <-
172      else  function(..., recursive = FALSE)
173          corpus <- ""  {
174        args <- list(...)
175        x <- args[[1L]]
176    
177      if (stripWhiteSpace)      if (length(args) == 1L)
178          corpus <- gsub("[[:space:]]+", " ", corpus)          return(x)
     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 <- ""  
179    
180      topics <- unlist(xmlApply(node[["TOPICS"]], function(x) xmlValue(x)), use.names = FALSE)      if (!all(unlist(lapply(args, inherits, class(x)))))
181            stop("not all arguments are of the same corpus type")
182    
183      new("PlainTextDocument", .Data = corpus, Cached = 1, Author = author, DateTimeStamp = datetimestamp,      structure(list(content = do.call("c", lapply(args, content)),
184          Description = description, ID = id, Origin = origin, Heading = heading, LocalMetaData = list(Topics = topics))                     meta = CorpusMeta(meta = do.call("c",
185                         lapply(args, function(a) meta(a, type = "corpus")))),
186                       dmeta = Reduce(outer_union, lapply(args, meta))),
187                  class = c("VCorpus", "Corpus"))
188    }
189    
190    content.VCorpus <-
191    function(x)
192    {
193        if (!is.null(x$lazy))
194            .Call(copyCorpus, x, materialize(x))
195        x$content
196    }
197    
198    content.PCorpus <-
199    function(x)
200    {
201        db <- filehash::dbInit(x$dbcontrol[["dbName"]], x$dbcontrol[["dbType"]])
202        filehash::dbMultiFetch(db, unlist(x$content))
203    }
204    
205    inspect <-
206    function(x)
207        UseMethod("inspect", x)
208    inspect.PCorpus <- inspect.VCorpus <-
209    function(x)
210    {
211        print(x)
212        cat("\n")
213        print(noquote(content(x)))
214        invisible(x)
215  }  }
216    
217  # Parse a <REUTERS></REUTERS> element from a well-formed Reuters-21578 XML file  length.PCorpus <- length.VCorpus <-
218  parseReutersXML<- function(file) {  function(x)
219      new("XMLTextDocument", FileName = file, Cached = 0, Author = "REUTERS", DateTimeStamp = date(),      length(x$content)
220          Description = "Reuters21578 file containing several news articles", ID = as.integer(0),  
221          Origin = "Reuters-21578 XML", Heading = "Reuters21578 news articles")  names.PCorpus <- names.VCorpus <-
222  }  function(x)
223        as.character(meta(x, "id", "local"))
224  setGeneric("loadFileIntoMem", function(object) standardGeneric("loadFileIntoMem"))  
225  setMethod("loadFileIntoMem",  print.PCorpus <- print.VCorpus <-
226            c("XMLTextDocument"),  function(x, ...)
227            function(object) {  {
228                if (object@Cached == 0) {      writeLines(sprintf("<<%s (documents: %d, metadata (corpus/indexed): %d/%d)>>",
229                    file <- object@FileName                         class(x)[1],
230                    doc <- xmlTreeParse(file)                         length(x),
231                    class(doc) <- "list"                         length(meta(x, type = "corpus")),
232                    object@.Data <- doc                         ncol(meta(x, type = "indexed"))))
233                    object@Cached <- 1      invisible(x)
234                    return(object)  }
235                } else {  
236                    return(object)  writeCorpus <-
237                }  function(x, path = ".", filenames = NULL)
238            })  {
239        filenames <- file.path(path,
240  setGeneric("tm_transform", function(object, FUN, ...) standardGeneric("tm_transform"))        if (is.null(filenames))
241  setMethod("tm_transform",            sprintf("%s.txt", as.character(meta(x, "id", "local")))
242            c("TextDocCol"),        else filenames)
           function(object, FUN, ...) {  
               lapply(object, FUN, ..., GlobalMetaData = GlobalMetaData(object))  
           })  
   
 setGeneric("toPlainTextDocument", function(object, FUN, ...) standardGeneric("toPlainTextDocument"))  
 setMethod("toPlainTextDocument",  
           c("PlainTextDocument"),  
           function(object, FUN, ...) {  
               return(object)  
           })  
 setMethod("toPlainTextDocument",  
           c("XMLTextDocument"),  
           function(object, FUN, ...) {  
               if (object@Cached == 0)  
                   object <- loadFileIntoMem(object)  
   
               corpus <- object@.Data  
   
               # As XMLDocument is no native S4 class, restore valid information  
               class(corpus) <- "XMLDocument"  
               names(corpus) <- c("doc","dtd")  
   
               return(xmlApply(xmlRoot(corpus), FUN, ...))  
           })  
   
 setGeneric("stemTextDocument", function(object, ...) standardGeneric("stemTextDocument"))  
 setMethod("stemTextDocument",  
           c("PlainTextDocument"),  
           function(object) {  
               require(Rstem)  
               splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))  
               stemmedCorpus <- wordStem(splittedCorpus)  
               object@.Data <- paste(stemmedCorpus, collapse = " ")  
               return (object)  
           })  
   
 setGeneric("removeStopWords", function(object, stopwords, ...) standardGeneric("removeStopWords"))  
 setMethod("removeStopWords",  
           c("PlainTextDocument", "character"),  
           function(object, stopwords) {  
               require(Rstem)  
               splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))  
               noStopwordsCorpus <- splittedCorpus[!splittedCorpus %in% stopwords]  
               object@.Data <- paste(noStopwordsCorpus, collapse = " ")  
               return (object)  
           })  
   
 setGeneric("tm_filter", function(object, FUN, ...) standardGeneric("tm_filter"))  
 setMethod("tm_filter",  
           c("TextDocCol"),  
           function(object, FUN, ...) {  
               sapply(object, FUN, ..., GlobalMetaData = GlobalMetaData(object))  
           })  
   
 setGeneric("filterREUT21578Topics", function(object, topics, ...) standardGeneric("filterREUT21578Topics"))  
 setMethod("filterREUT21578Topics",  
           c("PlainTextDocument", "character"),  
           function(object, topics) {  
               if (object@Cached == 0)  
                   object <- loadFileIntoMem(object)  
   
               if (any(object@LocalMetaData$Topics %in% topics))  
                   return(TRUE)  
               else  
                   return(FALSE)  
           })  
243    
244  setGeneric("filterIDs", function(object, IDs, ...) standardGeneric("filterIDs"))      stopifnot(length(x) == length(filenames))
 setMethod("filterIDs",  
           c("TextDocument", "numeric"),  
           function(object, IDs) {  
               if (object@ID %in% IDs)  
                   return(TRUE)  
               else  
                   return(FALSE)  
           })  
245    
246  setGeneric("attachData", function(object, data) standardGeneric("attachData"))      mapply(function(doc, f) writeLines(as.character(doc), f), x, filenames)
 setMethod("attachData",  
           c("TextDocCol","TextDocument"),  
           function(object, data) {  
               data <- as(list(data), "TextDocCol")  
               object@.Data <- as(c(object@.Data, data), "TextDocCol")  
               return(object)  
           })  
   
 setGeneric("attachMetaData", function(object, name, metadata) standardGeneric("attachMetaData"))  
 setMethod("attachMetaData",  
           c("TextDocCol"),  
           function(object, name, metadata) {  
               object@GlobalMetaData <- c(object@GlobalMetaData, new = list(metadata))  
               names(object@GlobalMetaData)[length(names(object@GlobalMetaData))] <- name  
               return(object)  
           })  
   
 setGeneric("setSubscriptable", function(object, name) standardGeneric("setSubscriptable"))  
 setMethod("setSubscriptable",  
           c("TextDocCol"),  
           function(object, name) {  
               if (!is.character(object@GlobalMetaData$subscriptable))  
                   object <- attachMetaData(object, "subscriptable", name)  
               else  
                   object@GlobalMetaData$subscriptable <- c(object@GlobalMetaData$subscriptable, name)  
               return(object)  
           })  
   
 setMethod("[",  
           signature(x = "TextDocCol", i = "ANY", j = "ANY", drop = "ANY"),  
           function(x, i, j, ... , drop) {  
               if(missing(i))  
                   return(x)  
247    
248                object <- x      invisible(x)
               object@.Data <- x@.Data[i, ..., drop = FALSE]  
               for (m in names(object@GlobalMetaData)) {  
                   if (m %in% object@GlobalMetaData$subscriptable) {  
                       object@GlobalMetaData[[m]] <- object@GlobalMetaData[[m]][i, ..., drop = FALSE]  
249                    }                    }
               }  
               return(object)  
           })  
   
 setMethod("c",  
           signature(x = "TextDocCol"),  
           function(x, ..., recursive = TRUE){  
               args <- list(...)  
               if(length(args) == 0)  
                   return(x)  
               return(as(c(as(x, "list"), ...), "TextDocCol"))  
     })  
   
 setMethod("length",  
           signature(x = "TextDocCol"),  
           function(x){  
               return(length(as(x, "list")))  
     })  
   
 setMethod("show",  
           signature(object = "TextDocCol"),  
           function(object){  
               cat("A text document collection with", length(object), "text document")  
               if (length(object) == 1)  
                   cat("\n")  
               else  
                   cat("s\n")  
     })  
   
 setMethod("summary",  
           signature(object = "TextDocCol"),  
           function(object){  
               show(object)  
               if (length(GlobalMetaData(object)) > 0) {  
                   cat("\nThe global metadata consists of", length(GlobalMetaData(object)), "tag-value pair")  
                   if (length(GlobalMetaData(object)) == 1)  
                       cat(".\n")  
                   else  
                       cat("s.\n")  
                   cat("Available tags are:\n")  
                   cat(names(GlobalMetaData(object)), "\n")  
               }  
     })  
   
 setGeneric("inspect", function(object) standardGeneric("inspect"))  
 setMethod("inspect",  
           c("TextDocCol"),  
           function(object) {  
               summary(object)  
               cat("\n")  
               show(as(object, "list"))  
           })  

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

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