| Title: | Compare R Package Differences |
| Version: | 0.1 |
| Date: | 2019-12-31 |
| Description: | It provides utility functions for investigating changes within R packages. The pkgInfo() function extracts package information such as exported and non-exported functions as well as their arguments. The pkgDiff() function compares this information for two versions of a package and creates a diff file viewable in a browser. |
| Imports: | diffr, htmlwidgets |
| License: | GPL-2 | GPL-3 [expanded from: GPL (≥ 2)] |
| Depends: | R (≥ 2.10) |
| URL: | https://github.com/couthcommander/packageDiff |
| Encoding: | UTF-8 |
| RoxygenNote: | 6.1.1 |
| NeedsCompilation: | no |
| Packaged: | 2020-01-13 16:19:45 UTC; beckca |
| Author: | Cole Beck  [aut,
cre] |
| Maintainer: | Cole Beck <cole.beck@vumc.org> |
| Repository: | CRAN |
| Date/Publication: | 2020-01-16 11:30:02 UTC |
Package Diff
Description
It provides utility functions for investigating changes within R packages.
The pkgInfo function extracts package information such as exported
and non-exported functions as well as their arguments. The pkgDiff
function compares this information for two versions of a package and creates
a diff file viewable in a browser.
Details
This package is experimental. Please submit bugs to https://github.com/couthcommander/packageDiff.
Author(s)
Cole Beck cole.beck@vumc.org
Maintainer: Cole Beck cole.beck@vumc.org
See Also
Useful links:
Examples
tar1 <- system.file("examples", "yaml_2.1.18.tar.gz", package = "packageDiff")
tar2 <- system.file("examples", "yaml_2.1.19.tar.gz", package = "packageDiff")
a <- pkgInfo(tar1)
b <- pkgInfo(tar2)
pkgDiff(a, b)
a <- pkgInfo('https://cran.r-project.org/src/contrib/Archive/yaml/yaml_2.1.18.tar.gz')
b <- pkgInfo('https://cran.r-project.org/src/contrib/Archive/yaml/yaml_2.1.19.tar.gz')
pkgDiff(a, b)
Package Diff
Description
This function compares version changes within packages.
Usage
pkgDiff(a, b, doc = TRUE, width = 80)
Arguments
a |
First package, a ‘pkgInfo’ object. |
b |
Second package, a ‘pkgInfo’ object. |
doc |
Include documentation in diff output. |
width |
Output width. |
Details
Generate diffs between package information.
Value
‘diffr’ object is open in browser
Examples
tar1 <- system.file("examples", "yaml_2.1.18.tar.gz", package = "packageDiff")
tar2 <- system.file("examples", "yaml_2.1.19.tar.gz", package = "packageDiff")
a <- pkgInfo(tar1)
b <- pkgInfo(tar2)
pkgDiff(a, b)
Extract Package Information
Description
This function extracts information from an R package.
Usage
pkgInfo(pkg, leaveRemains = FALSE)
Arguments
pkg |
The compressed (tar.gz) build file of an R package. |
leaveRemains |
Keep decompressed package in temp directory. |
Details
Generate package information from its build file.
Value
Package |
Package name |
Version |
Version number |
Imports |
Imported packages |
Suggests |
Suggested packages |
ImportedFunctions |
Functions imported from other packages |
ExportedFunctions |
Functions exported from package |
AllFunctions |
All defined functions |
FormalArgs |
Function arguments |
Data |
Dimension information on data sets |
documentation |
Full package documentation |
Examples
tarfile <- system.file("examples", "acepack_1.3-3.3.tar.gz", package = "packageDiff")
info <- pkgInfo(tarfile)
url <- 'https://cran.r-project.org/src/contrib/Archive/acepack/acepack_1.3-3.3.tar.gz'
info <- pkgInfo(url)
Print Package Information
Description
Print method for ‘packageInfo’ class.
Usage
## S3 method for class 'pkgInfo'
print(x, doc = FALSE, ...)
Arguments
x |
A packageInfo object. |
doc |
Include documentation in output. |
... |
Additional parameters, unused at this time. |
Details
Print its argument and return it invisibly.
Examples
tarfile <- system.file("examples", "acepack_1.3-3.3.tar.gz", package = "packageDiff")
pkgInfo(tarfile)
url <- 'https://cran.r-project.org/src/contrib/Archive/acepack/acepack_1.3-3.3.tar.gz'
info <- pkgInfo(url)
print(info)
Source Many R Scripts
Description
Evaluate R scripts in protected environment.
Usage
sourcerer(files, envir = NULL)
Arguments
files |
Vector of file names. |
envir |
Default environment. |
Details
This may fail if Collate is incorrect.
Message Suppressor
Description
Suppress messages and warnings.
Usage
suppresser(cmd)
Arguments
cmd |
R command to run. |
Extract R Package
Description
Untar an R package into a temp directory.
Usage
unzipPackage(x)
Arguments
x |
The compressed (tar.gz) build file of an R package, either local or URL. |
Value
List of files extracted.
Examples
tarfile <- system.file("examples", "acepack_1.3-3.3.tar.gz", package = "packageDiff")
info <- unzipPackage(tarfile)