electronicAppendix: Make an FDA-style Electronic Appendix from a Subversioned...

Description Usage Arguments Details Value Author(s) References See Also

Description

Make an FDA-style Electronic Appendix from a Subversioned Directory.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
electronicAppendix(
	x, 
	as=NULL, 
	pattern = NULL, 
	recursive = TRUE, 
	ignore.case = TRUE, 
	zip = FALSE, 
	at = numeric(0),
	...
)

Arguments

x

a Subversioned directory, e.g. a checkout of a repository or subdirectory thereof.

as

a file path for a directory to be created

pattern

passed to dir

recursive

passed to dir

ignore.case

passed to dir

zip

logical indicating whether to compress as to a zipped file.

at

a specific revision to export (head is exported by default, local changes preserved)

...

ignored

Details

FDA submissions may require electronic copies of file trees, where text files must have the extension ‘txt’. This function creates a copy of x using svn export (a system call). It fixes the names of those files that Subversion considers text, and optionally compresses the resulting directory to a zipped file (also a system call). Not tested on all platforms, but should work fine on most Unix-alikes.

For finer control over what is considered text, see svnMarkAsText and svnMarkAsNonText.

Note that non-subversioned files will not be included in the electronic appendix. An error results if any file is subversioned but missing.

as must be specified as a directory name. If zip is TRUE, .zip will be added.

as cannot pre-exist unless zip is true, in which case as will be renamed temporarily while its namesake is zipped and unlinked. By default, as is like x, followed by rev and revision number (if at is specified) and _EA.

Value

used for side effects

Author(s)

Tim Bergsma

References

http://metrumrg.googlecode.com

See Also


metrumrg documentation built on May 2, 2019, 5:55 p.m.