[rkward-cvs] SF.net SVN: rkward-code:[4525] trunk/rkward/packages/XiMpLe

m-eik at users.sf.net m-eik at users.sf.net
Mon Feb 4 21:38:33 UTC 2013


Revision: 4525
          http://sourceforge.net/p/rkward/code/4525
Author:   m-eik
Date:     2013-02-04 21:38:32 +0000 (Mon, 04 Feb 2013)
Log Message:
-----------
XiMpLe: added proper is.* and getter functions/methods for XiMpLe XML objects

Modified Paths:
--------------
    trunk/rkward/packages/XiMpLe/ChangeLog
    trunk/rkward/packages/XiMpLe/DESCRIPTION
    trunk/rkward/packages/XiMpLe/NAMESPACE
    trunk/rkward/packages/XiMpLe/R/XMLNode.R
    trunk/rkward/packages/XiMpLe/R/XMLTree.R
    trunk/rkward/packages/XiMpLe/R/XiMpLe-internal.R
    trunk/rkward/packages/XiMpLe/R/XiMpLe-package.R
    trunk/rkward/packages/XiMpLe/R/XiMpLe.doc-class.R
    trunk/rkward/packages/XiMpLe/R/XiMpLe.node-class.R
    trunk/rkward/packages/XiMpLe/R/node.R
    trunk/rkward/packages/XiMpLe/R/show-methods.R
    trunk/rkward/packages/XiMpLe/debian/changelog
    trunk/rkward/packages/XiMpLe/debian/changelog.rkward
    trunk/rkward/packages/XiMpLe/debian/copyright
    trunk/rkward/packages/XiMpLe/debian/rules
    trunk/rkward/packages/XiMpLe/inst/CITATION
    trunk/rkward/packages/XiMpLe/inst/NEWS.Rd
    trunk/rkward/packages/XiMpLe/man/XMLNode.Rd
    trunk/rkward/packages/XiMpLe/man/XMLTree.Rd
    trunk/rkward/packages/XiMpLe/man/XiMpLe-package.Rd
    trunk/rkward/packages/XiMpLe/man/show-methods.Rd

Added Paths:
-----------
    trunk/rkward/packages/XiMpLe/R/zzz_is_get_utils.R
    trunk/rkward/packages/XiMpLe/inst/doc/XiMpLe_vignette.pdf
    trunk/rkward/packages/XiMpLe/man/XMLGetters-methods.Rd

Modified: trunk/rkward/packages/XiMpLe/ChangeLog
===================================================================
--- trunk/rkward/packages/XiMpLe/ChangeLog	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/ChangeLog	2013-02-04 21:38:32 UTC (rev 4525)
@@ -1,5 +1,11 @@
 ChangeLog for package XiMpLe
 
+changes in version 0.03-17 (2013-02-04)
+added:
+  - added proper is.XiMpLe.node() and is.XiMpLe.doc() functions
+  - added getter functions for all slots in XiMpLe.node and XiMpLe.doc objects
+    (e.g., getXMLName() to get the name slot of a XiMpLe.node object)
+
 changes in version 0.03-16 (2012-11-05)
 added:
   - added examples to all functions

Modified: trunk/rkward/packages/XiMpLe/DESCRIPTION
===================================================================
--- trunk/rkward/packages/XiMpLe/DESCRIPTION	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/DESCRIPTION	2013-02-04 21:38:32 UTC (rev 4525)
@@ -19,8 +19,8 @@
 URL: http://reaktanz.de/?c=hacking&s=XiMpLe
 Authors at R: c(person(given="Meik", family="Michalke",
     email="meik.michalke at hhu.de", role=c("aut", "cre")))
-Version: 0.03-16
-Date: 2012-11-05
+Version: 0.03-17
+Date: 2013-02-04
 Collate:
     'XiMpLe-internal.R'
     'XiMpLe.node-class.R'
@@ -34,3 +34,4 @@
     'XiMpLe-package.R'
     'XMLNode.R'
     'XMLTree.R'
+    'zzz_is_get_utils.R'

Modified: trunk/rkward/packages/XiMpLe/NAMESPACE
===================================================================
--- trunk/rkward/packages/XiMpLe/NAMESPACE	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/NAMESPACE	2013-02-04 21:38:32 UTC (rev 4525)
@@ -1,5 +1,7 @@
 export(XMLNode)
 export(XMLTree)
+export(is.XiMpLe.doc)
+export(is.XiMpLe.node)
 export(parseXMLTree)
 export(pasteXMLNode)
 export(pasteXMLTag)
@@ -7,6 +9,13 @@
 exportClasses(XiMpLe.doc)
 exportClasses(XiMpLe.node)
 exportMethods("node<-")
+exportMethods(getXMLAttrs)
+exportMethods(getXMLChildren)
+exportMethods(getXMLDTD)
+exportMethods(getXMLDecl)
+exportMethods(getXMLFile)
+exportMethods(getXMLName)
+exportMethods(getXMLValue)
 exportMethods(node)
 exportMethods(pasteXML)
 exportMethods(show)

Modified: trunk/rkward/packages/XiMpLe/R/XMLNode.R
===================================================================
--- trunk/rkward/packages/XiMpLe/R/XMLNode.R	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/R/XMLNode.R	2013-02-04 21:38:32 UTC (rev 4525)
@@ -17,6 +17,7 @@
 #'		\code{\link[XiMpLe:XMLTree]{XMLTree}},
 #'		\code{\link[XiMpLe:pasteXML]{pasteXML}}
 #' @export
+#' @rdname XMLNode
 #' @examples
 #' sample.XML.node <- XMLNode("a",
 #'   attrs=list(href="http://example.com", target="_blank"),

Modified: trunk/rkward/packages/XiMpLe/R/XMLTree.R
===================================================================
--- trunk/rkward/packages/XiMpLe/R/XMLTree.R	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/R/XMLTree.R	2013-02-04 21:38:32 UTC (rev 4525)
@@ -15,6 +15,7 @@
 #'		\code{\link[XiMpLe:XMLNode]{XMLNode}},
 #'		\code{\link[XiMpLe:pasteXML]{pasteXML}}
 #' @export
+#' @rdname XMLTree
 #' @examples
 #' sample.XML.a <- XMLNode("a",
 #'   attrs=list(href="http://example.com", target="_blank"),

Modified: trunk/rkward/packages/XiMpLe/R/XiMpLe-internal.R
===================================================================
--- trunk/rkward/packages/XiMpLe/R/XiMpLe-internal.R	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/R/XiMpLe-internal.R	2013-02-04 21:38:32 UTC (rev 4525)
@@ -3,7 +3,7 @@
 ## function child.list()
 # convenience function to let single children be provided without list()
 child.list <- function(children){
-	if(inherits(children, "XiMpLe.node")){
+	if(is.XiMpLe.node(children)){
 		children <- list(children)
 	} else {
 		# if already a list, check if it's a list in a list and get it out

Modified: trunk/rkward/packages/XiMpLe/R/XiMpLe-package.R
===================================================================
--- trunk/rkward/packages/XiMpLe/R/XiMpLe-package.R	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/R/XiMpLe-package.R	2013-02-04 21:38:32 UTC (rev 4525)
@@ -3,8 +3,8 @@
 #' \tabular{ll}{
 #' Package: \tab XiMpLe\cr
 #' Type: \tab Package\cr
-#' Version: \tab 0.03-16\cr
-#' Date: \tab 2012-11-05\cr
+#' Version: \tab 0.03-17\cr
+#' Date: \tab 2013-02-04\cr
 #' Depends: \tab R (>= 2.9.0),methods\cr
 #' Enhances: \tab rkward\cr
 #' Encoding: \tab UTF-8\cr

Modified: trunk/rkward/packages/XiMpLe/R/XiMpLe.doc-class.R
===================================================================
--- trunk/rkward/packages/XiMpLe/R/XiMpLe.doc-class.R	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/R/XiMpLe.doc-class.R	2013-02-04 21:38:32 UTC (rev 4525)
@@ -56,7 +56,7 @@
 
 		# check content of children
 		if(length(obj.children) > 0){
-			child.nodes <- sapply(obj.children, function(this.child){inherits(this.child, "XiMpLe.node")})
+			child.nodes <- sapply(obj.children, function(this.child){is.XiMpLe.node(this.child)})
 			if(!all(child.nodes)){
 				stop(simpleError("Invalid object: All list elements of children must be of class XiMpLe.node!"))
 			} else {}

Modified: trunk/rkward/packages/XiMpLe/R/XiMpLe.node-class.R
===================================================================
--- trunk/rkward/packages/XiMpLe/R/XiMpLe.node-class.R	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/R/XiMpLe.node-class.R	2013-02-04 21:38:32 UTC (rev 4525)
@@ -65,7 +65,7 @@
 
 		# check content of children
 		if(length(obj.children) > 0){
-			child.nodes <- sapply(obj.children, function(this.child){inherits(this.child, "XiMpLe.node")})
+			child.nodes <- sapply(obj.children, function(this.child){is.XiMpLe.node(this.child)})
 			if(!all(child.nodes)){
 				stop(simpleError("Invalid object: All list elements of children must be of class XiMpLe.node!"))
 			} else {}

Modified: trunk/rkward/packages/XiMpLe/R/node.R
===================================================================
--- trunk/rkward/packages/XiMpLe/R/node.R	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/R/node.R	2013-02-04 21:38:32 UTC (rev 4525)
@@ -45,7 +45,7 @@
 	function(obj, node=list(), what=NULL, cond.attr=NULL, cond.value=NULL, element=NULL){
 
 		# check top level if this is a node, not a tree
-		if(inherits(obj, "XiMpLe.node")){
+		if(is.XiMpLe.node(obj)){
 			got.this <- identical(slot(obj, "name"), node[[1]])
 			if(!isTRUE(got.this)){
 				# apparently, this node doesn't exist
@@ -149,7 +149,7 @@
 
 		# no need for a list if it's inly one node
 		if(length(result) == 1){
-			if(inherits(result[[1]], "XiMpLe.node") | !is.null(element)){
+			if(is.XiMpLe.node(result[[1]]) | !is.null(element)){
 				result <- result[[1]]
 			} else {}
 		} else {}

Modified: trunk/rkward/packages/XiMpLe/R/show-methods.R
===================================================================
--- trunk/rkward/packages/XiMpLe/R/show-methods.R	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/R/show-methods.R	2013-02-04 21:38:32 UTC (rev 4525)
@@ -1,4 +1,4 @@
-#' Shows method for S4 objects of XiMpLe XML classes
+#' Show method for S4 objects of XiMpLe XML classes
 #' 
 #' Used to display objects of class \code{\link[XiMpLe:XiMpLe.doc-class]{XiMpLe.doc}}
 #' and \code{\link[XiMpLe:XiMpLe.node-class]{XiMpLe.node}}

Added: trunk/rkward/packages/XiMpLe/R/zzz_is_get_utils.R
===================================================================
--- trunk/rkward/packages/XiMpLe/R/zzz_is_get_utils.R	                        (rev 0)
+++ trunk/rkward/packages/XiMpLe/R/zzz_is_get_utils.R	2013-02-04 21:38:32 UTC (rev 4525)
@@ -0,0 +1,163 @@
+## the name "zzz_*" is just to ensure roxygen doesn't parse it before XMLNode.R and XMLTree.R
+
+#' @param x An arbitrary \code{R} object.
+#' @rdname XMLNode
+#' @export
+is.XiMpLe.node <- function(x){
+	inherits(x, "XiMpLe.node")
+}
+
+#' @param x An arbitrary \code{R} object.
+#' @rdname XMLTree
+#' @export
+is.XiMpLe.doc <- function(x){
+	inherits(x, "XiMpLe.doc")
+}
+
+
+#' Getter methods for S4 objects of XiMpLe XML classes
+#'
+#' Used to get certain slots from objects of class \code{\link[XiMpLe:XiMpLe.doc-class]{XiMpLe.doc}}
+#' and \code{\link[XiMpLe:XiMpLe.node-class]{XiMpLe.node}}.
+#' 
+#' These are convenience methods to get slots from XML objects without using the \code{@@} operator.
+#'
+#' @param obj An object of class \code{XiMpLe.node} or \code{XiMpLe.doc}
+#' @seealso
+#'		\code{\link[XiMpLe:XiMpLe.doc-class]{XiMpLe.doc}}
+#'		\code{\link[XiMpLe:XiMpLe.node-class]{XiMpLe.node}}
+#' @keywords methods
+#' @docType methods
+#' @rdname XMLGetters-methods
+#' @exportMethod getXMLName
+setGeneric("getXMLName", function(obj) standardGeneric("getXMLName"))
+
+#' @rdname XMLGetters-methods
+#' @aliases
+#'		getXMLName,-methods
+#'		getXMLName,XiMpLe.node-method
+#' @docType methods
+#' @include XiMpLe.node-class.R
+setMethod("getXMLName",
+	signature=signature(obj="XiMpLe.node"),
+	function(obj){
+		return(obj at name)
+	}
+)
+
+#' @rdname XMLGetters-methods
+#' @exportMethod getXMLAttrs
+setGeneric("getXMLAttrs", function(obj) standardGeneric("getXMLAttrs"))
+
+#' @rdname XMLGetters-methods
+#' @aliases
+#'		getXMLAttrs,-methods
+#'		getXMLAttrs,XiMpLe.node-method
+#' @docType methods
+#' @include XiMpLe.node-class.R
+setMethod("getXMLAttrs",
+	signature=signature(obj="XiMpLe.node"),
+	function(obj){
+		return(obj at attributes)
+	}
+)
+
+#' @rdname XMLGetters-methods
+#' @exportMethod getXMLChildren
+setGeneric("getXMLChildren", function(obj) standardGeneric("getXMLChildren"))
+
+#' @rdname XMLGetters-methods
+#' @aliases
+#'		getXMLChildren,-methods
+#'		getXMLChildren,XiMpLe.node-method
+#' @docType methods
+#' @include XiMpLe.node-class.R
+setMethod("getXMLChildren",
+	signature=signature(obj="XiMpLe.node"),
+	function(obj){
+		return(obj at children)
+	}
+)
+
+#' @rdname XMLGetters-methods
+#' @aliases
+#'		getXMLChildren,-methods
+#'		getXMLChildren,XiMpLe.doc-method
+#' @docType methods
+#' @include XiMpLe.doc-class.R
+setMethod("getXMLChildren",
+	signature=signature(obj="XiMpLe.doc"),
+	function(obj){
+		return(obj at children)
+	}
+)
+
+
+#' @rdname XMLGetters-methods
+#' @exportMethod getXMLValue
+setGeneric("getXMLValue", function(obj) standardGeneric("getXMLValue"))
+
+#' @rdname XMLGetters-methods
+#' @aliases
+#'		getXMLValue,-methods
+#'		getXMLValue,XiMpLe.node-method
+#' @docType methods
+#' @include XiMpLe.node-class.R
+setMethod("getXMLValue",
+	signature=signature(obj="XiMpLe.node"),
+	function(obj){
+		return(obj at value)
+	}
+)
+
+#' @rdname XMLGetters-methods
+#' @exportMethod getXMLFile
+setGeneric("getXMLFile", function(obj) standardGeneric("getXMLFile"))
+
+#' @rdname XMLGetters-methods
+#' @aliases
+#'		getXMLFile,-methods
+#'		getXMLFile,XiMpLe.doc-method
+#' @docType methods
+#' @include XiMpLe.doc-class.R
+setMethod("getXMLFile",
+	signature=signature(obj="XiMpLe.doc"),
+	function(obj){
+		return(obj at file)
+	}
+)
+
+#' @rdname XMLGetters-methods
+#' @exportMethod getXMLDecl
+setGeneric("getXMLDecl", function(obj) standardGeneric("getXMLDecl"))
+
+#' @rdname XMLGetters-methods
+#' @aliases
+#'		getXMLDecl,-methods
+#'		getXMLDecl,XiMpLe.doc-method
+#' @docType methods
+#' @include XiMpLe.doc-class.R
+setMethod("getXMLDecl",
+	signature=signature(obj="XiMpLe.doc"),
+	function(obj){
+		return(obj at xml)
+	}
+)
+
+#' @rdname XMLGetters-methods
+#' @exportMethod getXMLDTD
+setGeneric("getXMLDTD", function(obj) standardGeneric("getXMLDTD"))
+
+#' @rdname XMLGetters-methods
+#' @aliases
+#'		getXMLDTD,-methods
+#'		getXMLDTD,XiMpLe.doc-method
+#' @docType methods
+#' @include XiMpLe.doc-class.R
+setMethod("getXMLDTD",
+	signature=signature(obj="XiMpLe.doc"),
+	function(obj){
+		return(obj at dtd)
+	}
+)
+

Modified: trunk/rkward/packages/XiMpLe/debian/changelog
===================================================================
--- trunk/rkward/packages/XiMpLe/debian/changelog	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/debian/changelog	2013-02-04 21:38:32 UTC (rev 4525)
@@ -1,3 +1,9 @@
+r-other-reaktanz-ximple (0.03-17-1) unstable; urgency=low
+
+  * new upstream release
+
+ -- m.eik michalke <meik.michalke at hhu.de>  Mon, 04 Feb 2013 20:52:15 +0000
+
 r-other-reaktanz-ximple (0.03-16-1) unstable; urgency=low
 
   * new upstream release

Modified: trunk/rkward/packages/XiMpLe/debian/changelog.rkward
===================================================================
--- trunk/rkward/packages/XiMpLe/debian/changelog.rkward	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/debian/changelog.rkward	2013-02-04 21:38:32 UTC (rev 4525)
@@ -1,3 +1,9 @@
+r-other-rkward-ximple (0.03-17-1) unstable; urgency=low
+
+  * new upstream release
+
+ -- m.eik michalke <meik.michalke at hhu.de>  Mon, 04 Feb 2013 22:27:04 +0000
+
 r-other-rkward-ximple (0.03-16-1) unstable; urgency=low
 
   * new upstream release

Modified: trunk/rkward/packages/XiMpLe/debian/copyright
===================================================================
--- trunk/rkward/packages/XiMpLe/debian/copyright	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/debian/copyright	2013-02-04 21:38:32 UTC (rev 4525)
@@ -6,7 +6,7 @@
 'r-other-rkward-ximple' in harmony with the R packaging policy to indicate
 that the package is external to the CRAN or BioC repositories.
 
-XiMpLe Copyright (C) 2012 Meik Michalke, released under the
+XiMpLe Copyright (C) 2013 Meik Michalke, released under the
 GNU General Public License (GPL) version 3 or (at your option) any later version.
 
 This software is distributed in the hope that it will be useful, but

Modified: trunk/rkward/packages/XiMpLe/debian/rules
===================================================================
--- trunk/rkward/packages/XiMpLe/debian/rules	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/debian/rules	2013-02-04 21:38:32 UTC (rev 4525)
@@ -1,7 +1,7 @@
 #!/usr/bin/make -f
 #								-*- makefile -*-
 # debian/rules file for the Debian/GNU Linux r-other-rkward-ximple package
-# Copyright 2012 by m.eik michalke <meik.michalke at hhu.de>
+# Copyright 2013 by m.eik michalke <meik.michalke at hhu.de>
 
 debRreposname := other-rkward
 

Modified: trunk/rkward/packages/XiMpLe/inst/CITATION
===================================================================
--- trunk/rkward/packages/XiMpLe/inst/CITATION	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/inst/CITATION	2013-02-04 21:38:32 UTC (rev 4525)
@@ -1,13 +1,13 @@
 bibentry("Manual",
 		title="XiMpLe: A simple XML tree parser and generator",
 		author="Meik Michalke",
-		year="2012",
-		note="(Version 0.03-16)",
+		year="2013",
+		note="(Version 0.03-17)",
 		url="http://reaktanz.de/?c=hacking&s=XiMpLe",
 
 		textVersion =
-		paste("Michalke, M. (2012). ",
-				"XiMpLe: A simple XML tree parser and generator (Version 0.03-16). ",
+		paste("Michalke, M. (2013). ",
+				"XiMpLe: A simple XML tree parser and generator (Version 0.03-17). ",
 				"Available from http://reaktanz.de/?c=hacking&s=XiMpLe",
 				sep=""),
 

Modified: trunk/rkward/packages/XiMpLe/inst/NEWS.Rd
===================================================================
--- trunk/rkward/packages/XiMpLe/inst/NEWS.Rd	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/inst/NEWS.Rd	2013-02-04 21:38:32 UTC (rev 4525)
@@ -1,11 +1,21 @@
 \name{NEWS}
 \title{News for Package 'XiMpLe'}
 \encoding{UTF-8}
+\section{Changes in XiMpLe version 0.03-17 (2013-02-04)}{
+  \subsection{added}{
+    \itemize{
+      \item added proper \code{is.XiMpLe.node()} and \code{is.XiMpLe.doc()} functions
+      \item added getter functions for all slots in XiMpLe.node and XiMpLe.doc objects
+        (e.g., \code{getXMLName()} to get the name slot of a XiMpLe.node object)
+    }
+  }
+}
 \section{Changes in XiMpLe version 0.03-16 (2012-11-05)}{
   \subsection{added}{
     \itemize{
       \item added examples to all functions
       \item added a vignette
+      \item additional tests for \code{node()}<-
     }
   }
   \subsection{fixed}{
@@ -16,8 +26,17 @@
         instead of "<br />"
       \item parsing error for DOCTYPE nodes mixed up elements and previously ignored
         the \code{"decl"} value
+      \item \code{node()}<- now replaces both text values and pseudo tags with a new value.
+        this can still be problematic for child nodes which contain a mix of
+        pseudo and actual tags, so a warning will be given until this is resolved
     }
   }
+  \subsection{changed}{
+    \itemize{
+      \item \code{node()} now reports text values of nodes which have \code{"value"} and a pseudo
+        tag at the same time as one character string, like pasteXML does
+    }
+  }
 }
 \section{Changes in XiMpLe version 0.03-15 (2012-10-26)}{
   \subsection{fixed}{

Added: trunk/rkward/packages/XiMpLe/inst/doc/XiMpLe_vignette.pdf
===================================================================
(Binary files differ)

Index: trunk/rkward/packages/XiMpLe/inst/doc/XiMpLe_vignette.pdf
===================================================================
--- trunk/rkward/packages/XiMpLe/inst/doc/XiMpLe_vignette.pdf	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/inst/doc/XiMpLe_vignette.pdf	2013-02-04 21:38:32 UTC (rev 4525)

Property changes on: trunk/rkward/packages/XiMpLe/inst/doc/XiMpLe_vignette.pdf
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/rkward/packages/XiMpLe/man/XMLGetters-methods.Rd
===================================================================
--- trunk/rkward/packages/XiMpLe/man/XMLGetters-methods.Rd	                        (rev 0)
+++ trunk/rkward/packages/XiMpLe/man/XMLGetters-methods.Rd	2013-02-04 21:38:32 UTC (rev 4525)
@@ -0,0 +1,44 @@
+\docType{methods}
+\name{getXMLName}
+\alias{getXMLAttrs}
+\alias{getXMLAttrs,-methods}
+\alias{getXMLAttrs,XiMpLe.node-method}
+\alias{getXMLChildren}
+\alias{getXMLChildren,-methods}
+\alias{getXMLChildren,XiMpLe.doc-method}
+\alias{getXMLChildren,XiMpLe.node-method}
+\alias{getXMLDecl}
+\alias{getXMLDecl,-methods}
+\alias{getXMLDecl,XiMpLe.doc-method}
+\alias{getXMLDTD}
+\alias{getXMLDTD,-methods}
+\alias{getXMLDTD,XiMpLe.doc-method}
+\alias{getXMLFile}
+\alias{getXMLFile,-methods}
+\alias{getXMLFile,XiMpLe.doc-method}
+\alias{getXMLName}
+\alias{getXMLName,-methods}
+\alias{getXMLName,XiMpLe.node-method}
+\alias{getXMLValue}
+\alias{getXMLValue,-methods}
+\alias{getXMLValue,XiMpLe.node-method}
+\title{Getter methods for S4 objects of XiMpLe XML classes}
+\arguments{
+  \item{obj}{An object of class \code{XiMpLe.node} or
+  \code{XiMpLe.doc}}
+}
+\description{
+  Used to get certain slots from objects of class
+  \code{\link[XiMpLe:XiMpLe.doc-class]{XiMpLe.doc}} and
+  \code{\link[XiMpLe:XiMpLe.node-class]{XiMpLe.node}}.
+}
+\details{
+  These are convenience methods to get slots from XML
+  objects without using the \code{@} operator.
+}
+\seealso{
+  \code{\link[XiMpLe:XiMpLe.doc-class]{XiMpLe.doc}}
+  \code{\link[XiMpLe:XiMpLe.node-class]{XiMpLe.node}}
+}
+\keyword{methods}
+

Modified: trunk/rkward/packages/XiMpLe/man/XMLNode.Rd
===================================================================
--- trunk/rkward/packages/XiMpLe/man/XMLNode.Rd	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/man/XMLNode.Rd	2013-02-04 21:38:32 UTC (rev 4525)
@@ -1,9 +1,12 @@
 \name{XMLNode}
+\alias{is.XiMpLe.node}
 \alias{XMLNode}
 \title{Constructor function for XiMpLe.node objects}
 \usage{
   XMLNode(name, ..., attrs = NULL, namespace = "",
     namespaceDefinitions = NULL, .children = list(...))
+
+  is.XiMpLe.node(x)
 }
 \arguments{
   \item{name}{Character string, the tag name.}
@@ -22,6 +25,8 @@
 
   \item{.children}{Alternative way of specifying children,
   if you have them already as a list.}
+
+  \item{x}{An arbitrary \code{R} object.}
 }
 \value{
   An object of class

Modified: trunk/rkward/packages/XiMpLe/man/XMLTree.Rd
===================================================================
--- trunk/rkward/packages/XiMpLe/man/XMLTree.Rd	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/man/XMLTree.Rd	2013-02-04 21:38:32 UTC (rev 4525)
@@ -1,9 +1,12 @@
 \name{XMLTree}
+\alias{is.XiMpLe.doc}
 \alias{XMLTree}
 \title{Constructor function for XiMpLe.doc objects}
 \usage{
   XMLTree(..., xml = NULL, dtd = NULL,
     .children = list(...))
+
+  is.XiMpLe.doc(x)
 }
 \arguments{
   \item{...}{Optional children for the XML tree. Must be
@@ -23,6 +26,8 @@
 
   \item{.children}{Alternative way of specifying children,
   if you have them already as a list.}
+
+  \item{x}{An arbitrary \code{R} object.}
 }
 \value{
   An object of class

Modified: trunk/rkward/packages/XiMpLe/man/XiMpLe-package.Rd
===================================================================
--- trunk/rkward/packages/XiMpLe/man/XiMpLe-package.Rd	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/man/XiMpLe-package.Rd	2013-02-04 21:38:32 UTC (rev 4525)
@@ -8,8 +8,8 @@
 }
 \details{
   \tabular{ll}{ Package: \tab XiMpLe\cr Type: \tab
-  Package\cr Version: \tab 0.03-16\cr Date: \tab
-  2012-11-05\cr Depends: \tab R (>= 2.9.0),methods\cr
+  Package\cr Version: \tab 0.03-17\cr Date: \tab
+  2013-02-04\cr Depends: \tab R (>= 2.9.0),methods\cr
   Enhances: \tab rkward\cr Encoding: \tab UTF-8\cr License:
   \tab GPL (>= 3)\cr LazyLoad: \tab yes\cr URL: \tab
   http://reaktanz.de/?c=hacking&s=XiMpLe\cr }

Modified: trunk/rkward/packages/XiMpLe/man/show-methods.Rd
===================================================================
--- trunk/rkward/packages/XiMpLe/man/show-methods.Rd	2013-02-04 13:47:47 UTC (rev 4524)
+++ trunk/rkward/packages/XiMpLe/man/show-methods.Rd	2013-02-04 21:38:32 UTC (rev 4525)
@@ -4,7 +4,7 @@
 \alias{show,XiMpLe.doc-method}
 \alias{show,XiMpLe.node-method}
 \alias{show,XiMpLe.XML-method}
-\title{Shows method for S4 objects of XiMpLe XML classes}
+\title{Show method for S4 objects of XiMpLe XML classes}
 \arguments{
   \item{object}{An object of class \code{XiMpLe.doc} or
   \code{XiMpLe.node}}





More information about the rkward-tracker mailing list