[pkgdev.git] / README.md

# pkgdev: help to develop R packages

## NOTE: (mostly) superseded by devtools

However it was interesting to develop, and could still be used.

## 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)

Try also pkgTest/ testing package.

-----

Warning: old R package format - might require adjustments.
Commit	Line	Data
bd56ff4e BA	1	# pkgdev: help to develop R packages
bd56ff4e BA	2
f01d4a38 BA	3	## NOTE: (mostly) superseded by devtools
	4
	5	However it was interesting to develop, and could still be used.
	6
bd56ff4e BA	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
bb45e71f	26	pkgdev.unload(pkgpath)
bd56ff4e BA	27
bd56ff4e BA	28	Try also pkgTest/ testing package.
f01d4a38 BA	29
	30	-----
	31
	32	Warning: old R package format - might require adjustments.