Add some warnings in README
[pkgdev.git] / README.md
1 # pkgdev: help to develop R packages
2
3 ## NOTE: (mostly) superseded by devtools
4
5 However it was interesting to develop, and could still be used.
6
7 ## Basic usage
8
9 #Install and load library
10 R CMD INSTALL path/to/pkgdev/folder
11 library(pkgdev) #inside R
12
13 #load some package (with its datasets)
14 pkgpath = "path/to/some/package"
15 pkgdev.load(pkgpath) #this command also reload package
16
17 #test it (if unit tests defined under tests/ subfolders)
18 pkgdev.rtest(pkgpath) ; pkgdev.ctest(pkgpath)
19
20 #you can also run its functions
21 foo(...) ; bar(...)
22
23 #...and so on
24
25 #finally, unload package
26 pkgdev.unload(pkgpath)
27
28 Try also pkgTest/ testing package.
29
30 -----
31
32 Warning: old R package format - might require adjustments.