[rkward-cvs] SF.net SVN: rkward:[4269] trunk/rkward/rkward/rbackend/rpackages/ rkwardtests
m-eik at users.sourceforge.net
m-eik at users.sourceforge.net
Sun Jun 3 13:53:36 UTC 2012
Revision: 4269
http://rkward.svn.sourceforge.net/rkward/?rev=4269&view=rev
Author: m-eik
Date: 2012-06-03 13:53:36 +0000 (Sun, 03 Jun 2012)
Log Message:
-----------
rkwardtests: reformatted docs for the package and added license file
Modified Paths:
--------------
trunk/rkward/rkward/rbackend/rpackages/rkwardtests/DESCRIPTION
trunk/rkward/rkward/rbackend/rpackages/rkwardtests/NAMESPACE
trunk/rkward/rkward/rbackend/rpackages/rkwardtests/R/RKTest-class.R
trunk/rkward/rkward/rbackend/rpackages/rkwardtests/R/RKTestResult-class.R
trunk/rkward/rkward/rbackend/rpackages/rkwardtests/R/RKTestSuite-class.R
trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rktest.getTempDir.Rd
trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rktest.makeplugintests.Rd
trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rktest.replaceRunAgainLink.Rd
trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rktest.runRKTestSuite.Rd
trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rktest.setSuiteStandards.Rd
trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rkwardtests-package.Rd
trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/show.Rd
Added Paths:
-----------
trunk/rkward/rkward/rbackend/rpackages/rkwardtests/LICENSE
Modified: trunk/rkward/rkward/rbackend/rpackages/rkwardtests/DESCRIPTION
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwardtests/DESCRIPTION 2012-06-03 13:47:43 UTC (rev 4268)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwardtests/DESCRIPTION 2012-06-03 13:53:36 UTC (rev 4269)
@@ -1,13 +1,33 @@
Package: rkwardtests
Type: Package
Title: RKWard Plugin Test Suite Framework
-Version: 0.5.5
-Date: 2010-10-14
Author: Thomas Friedrichsmeier, Meik Michalke
-Maintainer: Thomas Friedrichsmeier <thomas.friedrichsmeier at ruhr-uni-bochum.de>, Meik Michalke <meik.michalke at uni-duesseldorf.de>
-Depends: R (>= 2.9.0),methods
-Description: A set of functions, classes and methods to test plugins that were written for RKWard.
+Maintainer: Thomas Friedrichsmeier <thomas.friedrichsmeier at ruhr-uni-bochum.de>,
+ Meik Michalke <meik.michalke at uni-duesseldorf.de>
+Depends:
+ R (>= 2.9.0),methods
+Description: A set of functions, classes and methods to test plugins that were
+ written for RKWard.
License: GPL (>= 2)
Encoding: UTF-8
LazyLoad: yes
URL: http://rkward.sourceforge.net
+Authors at R: c(person(given="Thomas", family="Friedrichsmeier",
+ email="thomas.friedrichsmeier at ruhr-uni-bochum.de", role=c("aut", "cre")),
+ person(given="Meik", family="Michalke", email="meik.michalke at hhu.de",
+ role=c("aut", "cre")))
+Version: 0.5.7
+Date: 2012-06-03
+Collate:
+ 'RKTest-class.R'
+ 'rktest.getTempDir.R'
+ 'rktest.makeplugintests.R'
+ 'rktest.replaceRunAgainLink.R'
+ 'RKTestResult-class.R'
+ 'rktest.runRKTestSuite.R'
+ 'rktest.setSuiteStandards.R'
+ 'RKTestSuite-class.R'
+ 'rkwardtests-internal.R'
+ 'rkwardtests-package.R'
+ 'roxyPackage-package.R'
+ 'show-method.R'
Added: trunk/rkward/rkward/rbackend/rpackages/rkwardtests/LICENSE
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwardtests/LICENSE (rev 0)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwardtests/LICENSE 2012-06-03 13:53:36 UTC (rev 4269)
@@ -0,0 +1,339 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
Modified: trunk/rkward/rkward/rbackend/rpackages/rkwardtests/NAMESPACE
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwardtests/NAMESPACE 2012-06-03 13:47:43 UTC (rev 4268)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwardtests/NAMESPACE 2012-06-03 13:53:36 UTC (rev 4269)
@@ -1,11 +1,11 @@
-import(methods)
exportClasses(RKTest)
+exportClasses(RKTestResult)
+exportClasses(RKTestSuite)
+exportMethods(show)
export(rktest.getTempDir)
export(rktest.makeplugintests)
export(rktest.replaceRunAgainLink)
-exportClasses(RKTestResult)
export(rktest.runRKTestSuite)
export(rktest.setSuiteStandards)
-exportClasses(RKTestSuite)
export(.rktest.tmp.storage)
-exportMethods(show)
+import(methods)
Modified: trunk/rkward/rkward/rbackend/rpackages/rkwardtests/R/RKTest-class.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwardtests/R/RKTest-class.R 2012-06-03 13:47:43 UTC (rev 4268)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwardtests/R/RKTest-class.R 2012-06-03 13:53:36 UTC (rev 4269)
@@ -1,19 +1,24 @@
+## temporarily turned off most of the roxygen comments
+## class docs will remain static until roxygen2 supports "@slot"
+
+#' S4 class RKTest
+#'
#' This class is used internally by \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}.
#'
-#' @title S4 class RKTest
-#' @slot id A unique character string
-#' @slot call A function to be called
-#' @slot fuzzy_output Allow fuzzy results
-#' @slot expect_error Expect errors
-#' @slot libraries A charcter vector naming needed libraries
-#' @slot files A character vector naming needed files, path relative to the test standards directory
-#' @slot record.all.commands Should synchronization commands and commands to generate run-again-links be included in the command recording? Generally, this should be FALSE (the default).
+#' @noRd
+# @slot id A unique character string
+# @slot call A function to be called
+# @slot fuzzy_output Allow fuzzy results
+# @slot expect_error Expect errors
+# @slot libraries A charcter vector naming needed libraries
+# @slot files A character vector naming needed files, path relative to the test standards directory
+# @slot record.all.commands Should synchronization commands and commands to generate run-again-links be included in the command recording? Generally, this should be FALSE (the default).
#' @name RKTest
#' @import methods
#' @keywords classes
#' @author Thomas Friedrichsmeier \email{thomas.friedrichsmeier@@ruhr-uni-bochum.de}
#' @exportClass RKTest
-#' @rdname RKTest-class
+# @rdname RKTest-class
setClass ("RKTest",
representation (id="character", call="function", fuzzy_output="logical", expect_error="logical", libraries="character", files="character", record.all.commands="logical"),
Modified: trunk/rkward/rkward/rbackend/rpackages/rkwardtests/R/RKTestResult-class.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwardtests/R/RKTestResult-class.R 2012-06-03 13:47:43 UTC (rev 4268)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwardtests/R/RKTestResult-class.R 2012-06-03 13:53:36 UTC (rev 4269)
@@ -1,21 +1,24 @@
-#' Class RKTestResult
+## temporarily turned off most of the roxygen comments
+## class docs will remain static until roxygen2 supports "@slot"
+
+#' S4 Class RKTestResult
#'
#' This class is used internally by \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}.
#'
-#' @title S4 class RKTestResult
-#' @slot id A unique character string naming a test.
-#' @slot code_match A character string indicating whether the run code matched the standard.
-#' @slot output_match A character string indicating whether the resulting output matched the standard.
-#' @slot message_match A character string indicating whether the resulting R messages matched the standard.
-#' @slot error A character string indicating errors.
-#' @slot missing_libs A character string indicating missing libraries.
-#' @slot passed Logical: Did the test pass?
+#' @noRd
+# @slot id A unique character string naming a test.
+# @slot code_match A character string indicating whether the run code matched the standard.
+# @slot output_match A character string indicating whether the resulting output matched the standard.
+# @slot message_match A character string indicating whether the resulting R messages matched the standard.
+# @slot error A character string indicating errors.
+# @slot missing_libs A character string indicating missing libraries.
+# @slot passed Logical: Did the test pass?
#' @name RKTestResult
#' @import methods
#' @keywords classes
#' @author Thomas Friedrichsmeier \email{thomas.friedrichsmeier@@ruhr-uni-bochum.de}
#' @exportClass RKTestResult
-#' @rdname RKTestResult-class
+# @rdname RKTestResult-class
setClass ("RKTestResult",
representation (id = "character", code_match = "character", output_match = "character", message_match = "character", error="character", missing_libs="character", passed="logical"),
Modified: trunk/rkward/rkward/rbackend/rpackages/rkwardtests/R/RKTestSuite-class.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwardtests/R/RKTestSuite-class.R 2012-06-03 13:47:43 UTC (rev 4268)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwardtests/R/RKTestSuite-class.R 2012-06-03 13:53:36 UTC (rev 4269)
@@ -1,19 +1,22 @@
-#' Class RKTestSuite
+## temporarily turned off most of the roxygen comments
+## class docs will remain static until roxygen2 supports "@slot"
+
+#' S4 Class RKTestSuite
#'
#' This class is used to create test suite objects that can be fed to \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}.
#'
-#' @title S4 class RKTestSuite
-#' @slot id A unique character string to identify a test suite
-#' @slot libraries A charcter vector naming libraries that the test suite depends on.
-#' @slot initCalls A list of functions to be run before any tests, e.g. to load libraries or data objects.
-#' @slot tests A list of the actual plugin tests.
-#' @slot postCalls A list of functions to be run after all tests, e.g. to clean up.
+#' @noRd
+# @slot id A unique character string to identify a test suite
+# @slot libraries A charcter vector naming libraries that the test suite depends on.
+# @slot initCalls A list of functions to be run before any tests, e.g. to load libraries or data objects.
+# @slot tests A list of the actual plugin tests.
+# @slot postCalls A list of functions to be run after all tests, e.g. to clean up.
#' @name RKTestSuite
#' @import methods
#' @keywords classes
#' @author Thomas Friedrichsmeier \email{thomas.friedrichsmeier@@ruhr-uni-bochum.de}
#' @exportClass RKTestSuite
-#' @rdname RKTestSuite-class
+# @rdname RKTestSuite-class
setClass ("RKTestSuite",
representation (id="character", libraries="character", initCalls="list", tests="list", postCalls="list"),
Modified: trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rktest.getTempDir.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rktest.getTempDir.Rd 2012-06-03 13:47:43 UTC (rev 4268)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rktest.getTempDir.Rd 2012-06-03 13:53:36 UTC (rev 4269)
@@ -1,14 +1,29 @@
\name{rktest.getTempDir}
\alias{rktest.getTempDir}
\title{Get path to the temporary directory}
-\usage{rktest.getTempDir()}
-\description{Get the path to the recent temporary directory, if one exists.}
-\details{This function will return either the local path to the temporary directory where
-all test results have been saved to, or FALSE if none exitsts.}
-\alias{rktest.getTempDir}
-\value{Either a character string, or FALSE.}
-\author{Meik Michalke \email{meik.michalke at uni-duesseldorf.de}}
+\usage{
+ rktest.getTempDir()
+}
+\value{
+ Either a character string, or FALSE.
+}
+\description{
+ Get the path to the recent temporary directory, if one
+ exists.
+}
+\details{
+ This function will return either the local path to the
+ temporary directory where all test results have been
+ saved to, or FALSE if none exitsts.
+}
+\examples{
+rktest.getTempDir()
+}
+\author{
+ Meik Michalke \email{meik.michalke at uni-duesseldorf.de}
+}
+\seealso{
+ \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}
+}
\keyword{utilities}
-\seealso{\code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}}
-\examples{rktest.getTempDir()}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rktest.makeplugintests.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rktest.makeplugintests.Rd 2012-06-03 13:47:43 UTC (rev 4268)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rktest.makeplugintests.Rd 2012-06-03 13:53:36 UTC (rev 4269)
@@ -1,25 +1,57 @@
\name{rktest.makeplugintests}
\alias{rktest.makeplugintests}
\title{Run RKWard plugin test suite}
-\usage{rktest.makeplugintests(testsuites="testsuite.R", testroot=getwd(),
-outfile="make_plugintests.txt", append=FALSE, test.id=NULL)}
-\description{Run a whole RKWard plugin test suite}
-\details{The function \code{rktest.makeplugintests} will run a whole test suite that was prepared to check one or several RKWard plugins.}
-\alias{rktest.makeplugintests}
-\value{Results are printed to stdout and saved to the defined output file.}
-\author{Thomas Friedrichsmeier \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}, Meik Michalke \email{meik.michalke at uni-duesseldorf.de}}
-\keyword{utilities}
-\seealso{\code{\link[rkwardtests:RKTestSuite]{RKTestSuite-class}}, \code{\link[rkwardtests:RKTestResult]{RKTestResult-class}}}
-\arguments{\item{testsuites}{A character string or vector naming the test suites to be run.}
-\item{testroot}{A character string pointing to the root directory where the test suite resides (including its folder with test standards).}
-\item{outfile}{A character string giving a file name for the result log.}
-\item{append}{If TRUE, append output to an existing file.}
-\item{test.id}{Optional character string or vector naming one or more tests of a suite to be run (if NULL, all tests are run).}
+\usage{
+ rktest.makeplugintests(testsuites="testsuite.R",
+ testroot=getwd(), outfile="make_plugintests.txt",
+ append=FALSE, test.id=NULL)
}
-\examples{\dontrun{
+\arguments{
+ \item{testsuites}{A character string or vector naming the
+ test suites to be run.}
+
+ \item{testroot}{A character string pointing to the root
+ directory where the test suite resides (including its
+ folder with test standards).}
+
+ \item{outfile}{A character string giving a file name for
+ the result log.}
+
+ \item{append}{If TRUE, append output to an existing
+ file.}
+
+ \item{test.id}{Optional character string or vector naming
+ one or more tests of a suite to be run (if NULL, all
+ tests are run).}
+}
+\value{
+ Results are printed to stdout and saved to the defined
+ output file.
+}
+\description{
+ Run a whole RKWard plugin test suite
+}
+\details{
+ The function \code{rktest.makeplugintests} will run a
+ whole test suite that was prepared to check one or
+ several RKWard plugins.
+}
+\examples{
+\dontrun{
rktest.makeplugintests(testsuites=c("rkward_application_tests.R",
-"import_export_plugins.R"), testroot=getwd())
+ "import_export_plugins.R"), testroot=getwd())
rktest.makeplugintests(testsuites="distribution.R",
-testroot=getwd(), test.id=c("poisson_quantiles", "geom_quantiles"))
-}}
+ testroot=getwd(), test.id=c("poisson_quantiles", "geom_quantiles"))
+}
+}
+\author{
+ Thomas Friedrichsmeier
+ \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}, Meik
+ Michalke \email{meik.michalke at uni-duesseldorf.de}
+}
+\seealso{
+ \code{\link[rkwardtests:RKTestSuite]{RKTestSuite-class}},
+ \code{\link[rkwardtests:RKTestResult]{RKTestResult-class}}
+}
+\keyword{utilities}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rktest.replaceRunAgainLink.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rktest.replaceRunAgainLink.Rd 2012-06-03 13:47:43 UTC (rev 4268)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rktest.replaceRunAgainLink.Rd 2012-06-03 13:53:36 UTC (rev 4269)
@@ -1,19 +1,40 @@
\name{rktest.replaceRunAgainLink}
+\alias{.rk.rerun.plugin.link.replacement}
\alias{rktest.replaceRunAgainLink}
\title{Replace "Run again" link in RKWard}
-\usage{rktest.replaceRunAgainLink(restore=FALSE)}
-\description{Replace "Run again" link in RKWard with code}
-\details{You can use this to temporarily replace .rk.rerun.plugin.link (see example below).
-This way, after running a plugin, you are shown the call needed to run this
-plugin with those settings, instead of the link.
+\usage{
+ rktest.replaceRunAgainLink(restore=FALSE)
+}
+\arguments{
+ \item{restore}{Logical: If TRUE, restore the original
+ behaviour.}
+}
+\value{
+ Replaces the "Run again" link in RKWard with the code
+ that would have been called, or vice versa.
+}
+\description{
+ Replace "Run again" link in RKWard with code
+}
+\details{
+ You can use this to temporarily replace
+ .rk.rerun.plugin.link (see example below). This way,
+ after running a plugin, you are shown the call needed to
+ run this plugin with those settings, instead of the link.
-This code can be used in a plugin test suite.}
-\alias{.rk.rerun.plugin.link.replacement}
-\value{Replaces the "Run again" link in RKWard with the code that would have been called, or vice versa.}
-\author{Thomas Friedrichsmeier \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}, Meik Michalke \email{meik.michalke at uni-duesseldorf.de}}
+ This code can be used in a plugin test suite.
+}
+\examples{
+rktest.replaceRunAgainLink()
+}
+\author{
+ Thomas Friedrichsmeier
+ \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}, Meik
+ Michalke \email{meik.michalke at uni-duesseldorf.de}
+}
+\seealso{
+ \code{\link[rkwardtests:RKTestSuite]{RKTestSuite-class}},
+ \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}
+}
\keyword{utilities}
-\seealso{\code{\link[rkwardtests:RKTestSuite]{RKTestSuite-class}}, \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}}
-\arguments{\item{restore}{Logical: If TRUE, restore the original behaviour.}
-}
-\examples{rktest.replaceRunAgainLink()}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rktest.runRKTestSuite.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rktest.runRKTestSuite.Rd 2012-06-03 13:47:43 UTC (rev 4268)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rktest.runRKTestSuite.Rd 2012-06-03 13:53:36 UTC (rev 4269)
@@ -1,19 +1,44 @@
\name{rktest.runRKTestSuite}
\alias{rktest.runRKTestSuite}
\title{Run RKWard plugin test suite}
-\usage{rktest.runRKTestSuite(suite, testroot=getwd(), test.id=NULL)}
-\description{Run a single RKWard plugin test suite}
-\details{This function can be called to run a single plugin test suite.}
-\alias{rktest.runRKTestSuite}
-\value{An object of class \code{\link[rkwardtests:RKTestResult]{RKTestResult-class}}.}
-\author{Thomas Friedrichsmeier \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}, Meik Michalke \email{meik.michalke at uni-duesseldorf.de}}
-\keyword{utilities}
-\seealso{\code{\link[rkwardtests:RKTestSuite]{RKTestSuite-class}}, \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}}
-\arguments{\item{suite}{Character string naming the test suite to run.}
-\item{testroot}{Defaults to the working directory.}
-\item{test.id}{An optional character string or vector naming one or more tests of a suite to be run (if NULL, all tests are run).}
+\usage{
+ rktest.runRKTestSuite(suite, testroot=getwd(),
+ test.id=NULL)
}
-\examples{\dontrun{
+\arguments{
+ \item{suite}{Character string naming the test suite to
+ run.}
+
+ \item{testroot}{Defaults to the working directory.}
+
+ \item{test.id}{An optional character string or vector
+ naming one or more tests of a suite to be run (if NULL,
+ all tests are run).}
+}
+\value{
+ An object of class
+ \code{\link[rkwardtests:RKTestResult]{RKTestResult-class}}.
+}
+\description{
+ Run a single RKWard plugin test suite
+}
+\details{
+ This function can be called to run a single plugin test
+ suite.
+}
+\examples{
+\dontrun{
result <- rktest.runRKTestSuite()
-}}
+}
+}
+\author{
+ Thomas Friedrichsmeier
+ \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}, Meik
+ Michalke \email{meik.michalke at uni-duesseldorf.de}
+}
+\seealso{
+ \code{\link[rkwardtests:RKTestSuite]{RKTestSuite-class}},
+ \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}
+}
+\keyword{utilities}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rktest.setSuiteStandards.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rktest.setSuiteStandards.Rd 2012-06-03 13:47:43 UTC (rev 4268)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rktest.setSuiteStandards.Rd 2012-06-03 13:53:36 UTC (rev 4269)
@@ -1,22 +1,46 @@
\name{rktest.setSuiteStandards}
\alias{rktest.setSuiteStandards}
\title{Set RKWard suite standards}
-\usage{rktest.setSuiteStandards(suite, testroot=getwd(), file=TRUE)}
-\description{Set RKWard plugin test suite standards}
-\details{Use this function after you plugin passed all tests to set the resulting code,
-output and R messages as the standard that will be compared to during following tests.}
-\alias{rktest.setSuiteStandards}
-\value{The function simply copies the previously created files from the temporary directory to
-the directory with the test standards.}
-\author{Thomas Friedrichsmeier \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}}
-\keyword{utilities}
-\seealso{\code{\link[rkwardtests:RKTestSuite]{RKTestSuite-class}}, \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}}
-\arguments{\item{suite}{Character string naming the test suite to set standards for.}
-\item{testroot}{Path to the test root directory, defaults to the working directory.}
-\item{file}{Logical: If \code{suite} is already a present R object, set this to FALSE.
-Otherwise it is assumed to be a file and fed to \code{source}.}
+\usage{
+ rktest.setSuiteStandards(suite, testroot=getwd(),
+ file=TRUE)
}
-\examples{\dontrun{
+\arguments{
+ \item{suite}{Character string naming the test suite to
+ set standards for.}
+
+ \item{testroot}{Path to the test root directory, defaults
+ to the working directory.}
+
+ \item{file}{Logical: If \code{suite} is already a present
+ R object, set this to FALSE. Otherwise it is assumed to
+ be a file and fed to \code{source}.}
+}
+\value{
+ The function simply copies the previously created files
+ from the temporary directory to the directory containing
+ the test standards (inside the testroot).
+}
+\description{
+ Set RKWard plugin test suite standards
+}
+\details{
+ Use this function after you plugin passed all tests to
+ set the resulting code, output and R messages as the
+ standard that will be compared to during following tests.
+}
+\examples{
+\dontrun{
rktest.setSuiteStandards("rkward_application_tests.R")
-}}
+}
+}
+\author{
+ Thomas Friedrichsmeier
+ \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}
+}
+\seealso{
+ \code{\link[rkwardtests:RKTestSuite]{RKTestSuite-class}},
+ \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}
+}
+\keyword{utilities}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rkwardtests-package.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rkwardtests-package.Rd 2012-06-03 13:47:43 UTC (rev 4268)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/rkwardtests-package.Rd 2012-06-03 13:53:36 UTC (rev 4269)
@@ -1,25 +1,24 @@
+\docType{package}
\name{rkwardtests-package}
+\alias{rkwardtests}
\alias{rkwardtests-package}
-\alias{rkwardtests-package}
\title{RKWard Plugin Test Suite Framework.}
-\description{RKWard Plugin Test Suite Framework.}
-\details{\tabular{ll}{
-Package: \tab rkwardtests\cr
-Type: \tab Package\cr
-Version: \tab 0.5.5\cr
-Date: \tab 2010-10-14\cr
-Depends: \tab R (>= 2.9.0),methods\cr
-Encoding: \tab UTF-8\cr
-License: \tab GPL (>= 3)\cr
-LazyLoad: \tab yes\cr
-URL: \tab http://rkward.sourceforge.net \cr
+\description{
+ RKWard Plugin Test Suite Framework.
}
+\details{
+ \tabular{ll}{ Package: \tab rkwardtests\cr Type: \tab
+ Package\cr Version: \tab 0.5.7\cr Date: \tab
+ 2012-06-03\cr Depends: \tab R (>= 2.9.0),methods\cr
+ Encoding: \tab UTF-8\cr License: \tab GPL (>= 2)\cr
+ LazyLoad: \tab yes\cr URL: \tab
+ http://rkward.sourceforge.net\cr }
-A set of functions, classes and methods to test plugins that were written for RKWard.}
-\alias{rkwardtests-package}
-\alias{rkwardtests}
-\docType{package}
-\author{Thomas Friedrichsmeier \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}, Meik Michalke \email{meik.michalke at uni-duesseldorf.de}}
+ A set of functions, classes and methods to test plugins
+ that were written for RKWard.
+}
+\author{
+ Thomas Friedrichsmeier, Meik Michalke
+}
\keyword{package}
-\seealso{\code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/show.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/show.Rd 2012-06-03 13:47:43 UTC (rev 4268)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwardtests/man/show.Rd 2012-06-03 13:53:36 UTC (rev 4269)
@@ -1,17 +1,24 @@
\name{show}
-\alias{show,-method}
\alias{show}
+\alias{show,RKTestResult-method}
\title{show method for objects of class RKTestResult}
-\usage{\method{show}{RKTestResult}(object)
+\arguments{
+ \item{object}{An object of class RKTestResult}
}
-\description{show method for S4 objects of class RKTestResult}
-\details{Prints a summary of plugin test results.}
-\alias{show,RKTestResult-method}
-\author{Thomas Friedrichsmeier \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}}
-\keyword{methods}
-\arguments{\item{object}{An object of class RKTestResult}
+\description{
+ show method for S4 objects of class RKTestResult
}
-\examples{\dontrun{
+\details{
+ Prints a summary of plugin test results.
+}
+\examples{
+\dontrun{
rktest.makeplugintests("rkward_application_tests.R")
-}}
+}
+}
+\author{
+ Thomas Friedrichsmeier
+ \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}
+}
+\keyword{methods}
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the rkward-tracker
mailing list