From: Benjamin Auder <benjamin.auder@somewhere> Date: Fri, 22 Jul 2016 14:39:30 +0000 (+0200) Subject: readme.md X-Git-Url: https://git.auder.net/variants/img/pieces/scripts/doc/html/index.css?a=commitdiff_plain;h=bd56ff4e74044286d1d85a4065dc6739798ca721;p=pkgdev.git readme.md --- diff --git a/README.html b/README.html deleted file mode 100644 index cf6a12b..0000000 --- a/README.html +++ /dev/null @@ -1,24 +0,0 @@ -<h1>pkgdev: help to develop R packages</h1> - -<h2>Basic usage</h2> - -<pre><code> #Install and load library - R CMD INSTALL path/to/pkgdev/folder - library(pkgdev) #inside R - - #load some package (with its datasets) - pkgpath = "path/to/some/package" - pkgdev.load(pkgpath) #this command also reload package - - #test it (if unit tests defined under tests/ subfolders) - pkgdev.rtest(pkgpath) ; pkgdev.ctest(pkgpath) - - #you can also run its functions - foo(...) ; bar(...) - - #...and so on - - #finally, unload package - pkgdev.unload(pkgpath)</code></pre> - -<p>Try also pkgTest/ testing package.</p> diff --git a/README.md b/README.md new file mode 100644 index 0000000..b36c33d --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# pkgdev: help to develop R packages + +## Basic usage + + #Install and load library + R CMD INSTALL path/to/pkgdev/folder + library(pkgdev) #inside R + + #load some package (with its datasets) + pkgpath = "path/to/some/package" + pkgdev.load(pkgpath) #this command also reload package + + #test it (if unit tests defined under tests/ subfolders) + pkgdev.rtest(pkgpath) ; pkgdev.ctest(pkgpath) + + #you can also run its functions + foo(...) ; bar(...) + + #...and so on + + #finally, unload package + pkgdev.unload(pkgpath)</code></pre> + +Try also pkgTest/ testing package.