From 82ec438da0a01e6bed7accd1d2d08abcbc058cc0 Mon Sep 17 00:00:00 2001 From: Brian Burns Date: Thu, 1 Nov 2018 16:12:26 -0500 Subject: [PATCH 1/3] version update for minor release --- DESCRIPTION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index 8d882b72..0892fe53 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: pkgnet Type: Package Title: Get Network Representation of an R Package -Version: 0.2.0.9000 +Version: 0.2.1.9000 Authors@R: c( person("Brian", "Burns", email = "brian.burns@uptake.com", role = c("aut", "cre")), person("James", "Lamb", email = "james.lamb@uptake.com", role = c("aut")), From adca97b7d2d64e5a8b17fb3492f4ea2d2e916b5f Mon Sep 17 00:00:00 2001 From: Brian Burns Date: Thu, 1 Nov 2018 16:14:19 -0500 Subject: [PATCH 2/3] CRAN comments --- cran-comments.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/cran-comments.md b/cran-comments.md index e6805c41..b2484669 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,5 +1,11 @@ # CRAN Submission History +## v 0.2.1 - Submission 3 - (November 1st, 2018) + +This is a minor release to address a bug with the `report_path` parameter of `CreatePackageReport`. Prior to this fix, reports would continue to be saved to a default location rather than the file path supplied by the user. + +Other items in this release are typo corrections, some additional parameter checks, and more verbose error and info messages. + ## v 0.2.0 - Submission 2 - (April 30th, 2018) * Resubmitted to CRAN without test folder or source vigette code. * This was to ensure nothing is written outside of the temp folder From 51528c60c19d21ae96f008365e2fbd7ae434cd42 Mon Sep 17 00:00:00 2001 From: Brian Burns Date: Thu, 1 Nov 2018 16:50:55 -0500 Subject: [PATCH 3/3] doc update --- DESCRIPTION | 2 +- _pkgdown.yml | 6 + docs/CONDUCT.html | 2 +- docs/CONTRIBUTING.html | 2 +- docs/LICENSE-text.html | 2 +- docs/articles/index.html | 2 +- docs/articles/pkgnet-intro.html | 4 +- docs/authors.html | 2 +- docs/index.html | 5 +- docs/reference/AbstractGraphReporter.html | 6 +- docs/reference/AbstractPackageReporter.html | 2 +- docs/reference/CreatePackageReport.html | 2 +- docs/reference/DefaultReporters.html | 2 +- docs/reference/DependencyReporter.html | 6 +- docs/reference/FunctionReporter.html | 8 +- docs/reference/SummaryReporter.html | 2 +- docs/reference/doc_shared.html | 149 ++++++++++++++++++++ docs/reference/index.html | 6 +- man/AbstractGraphReporter.Rd | 1 + man/AbstractPackageReporter.Rd | 1 + man/DependencyReporter.Rd | 1 + man/FunctionReporter.Rd | 1 + man/SummaryReporter.Rd | 1 + man/doc_shared.Rd | 16 +++ 24 files changed, 205 insertions(+), 26 deletions(-) create mode 100644 docs/reference/doc_shared.html create mode 100644 man/doc_shared.Rd diff --git a/DESCRIPTION b/DESCRIPTION index 0892fe53..b092fb4c 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -35,5 +35,5 @@ License: BSD_3_clause + file LICENSE URL: https://github.com/UptakeOpenSource/pkgnet BugReports: https://github.com/UptakeOpenSource/pkgnet/issues LazyData: TRUE -RoxygenNote: 6.0.1 +RoxygenNote: 6.1.0 VignetteBuilder: knitr diff --git a/_pkgdown.yml b/_pkgdown.yml index 3db306bf..2ade71e7 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -16,3 +16,9 @@ navbar: right: - icon: fa-github href: https://github.com/uptakeopensource/pkgnet + +reference: +- title: All Functions + contents: + - -matches("doc_shared") + diff --git a/docs/CONDUCT.html b/docs/CONDUCT.html index f95eb6e7..1ca8fc65 100644 --- a/docs/CONDUCT.html +++ b/docs/CONDUCT.html @@ -54,7 +54,7 @@ pkgnet - 0.2.0.9000 + 0.2.1.9000 diff --git a/docs/CONTRIBUTING.html b/docs/CONTRIBUTING.html index 180c3ab3..03ba82c1 100644 --- a/docs/CONTRIBUTING.html +++ b/docs/CONTRIBUTING.html @@ -54,7 +54,7 @@ pkgnet - 0.2.0.9000 + 0.2.1.9000 diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index 5da8ff7c..22e2a9ba 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -54,7 +54,7 @@ pkgnet - 0.2.0.9000 + 0.2.1.9000 diff --git a/docs/articles/index.html b/docs/articles/index.html index 00c822e4..75b732cf 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -54,7 +54,7 @@ pkgnet - 0.2.0.9000 + 0.2.1.9000 diff --git a/docs/articles/pkgnet-intro.html b/docs/articles/pkgnet-intro.html index cb4f77d6..bf5f1ae5 100644 --- a/docs/articles/pkgnet-intro.html +++ b/docs/articles/pkgnet-intro.html @@ -29,7 +29,7 @@ pkgnet - 0.2.0.9000 + 0.2.1.9000 @@ -5126,7 +5126,7 @@

  • -C is dependent upon both A and C. +C is dependent upon both A and B.
  • D is dependent upon both C and B. diff --git a/docs/authors.html b/docs/authors.html index 4a0f250b..d88ef323 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -54,7 +54,7 @@ pkgnet - 0.2.0.9000 + 0.2.1.9000 diff --git a/docs/index.html b/docs/index.html index d201ad14..5481555c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -32,7 +32,7 @@ pkgnet - 0.2.0.9000 + 0.2.1.9000 @@ -77,7 +77,7 @@

    pkgnet is an R library designed for the analysis of R libraries! The goal of the package is to build a graph representation of a package and its dependencies to inform a variety of activities, including:

    • prioritizing functions to unit test based on their centrality
      • -
    • examining the recursive depdencies you are taking on by using a given package
      • +
    • examining the recursive dependencies you are taking on by using a given package
    • exploring the structure of a new package provided by a coworker or downloaded from the internet
    @@ -165,6 +165,7 @@

    Dev status

  • CRAN_Status_Badge
  • CRAN_Download_Badge
  • Build Status
    • +
  • codecov
diff --git a/docs/reference/AbstractGraphReporter.html b/docs/reference/AbstractGraphReporter.html index e082f564..1ed98341 100644 --- a/docs/reference/AbstractGraphReporter.html +++ b/docs/reference/AbstractGraphReporter.html @@ -59,7 +59,7 @@ pkgnet - 0.2.0.9000 + 0.2.1.9000 @@ -131,9 +131,9 @@

pkgnet - 0.2.0.9000 + 0.2.1.9000 diff --git a/docs/reference/CreatePackageReport.html b/docs/reference/CreatePackageReport.html index 77c36c0f..ead2fbab 100644 --- a/docs/reference/CreatePackageReport.html +++ b/docs/reference/CreatePackageReport.html @@ -57,7 +57,7 @@ pkgnet - 0.2.0.9000 + 0.2.1.9000 diff --git a/docs/reference/DefaultReporters.html b/docs/reference/DefaultReporters.html index d16f3f86..a09a27cb 100644 --- a/docs/reference/DefaultReporters.html +++ b/docs/reference/DefaultReporters.html @@ -57,7 +57,7 @@ pkgnet - 0.2.0.9000 + 0.2.1.9000 diff --git a/docs/reference/DependencyReporter.html b/docs/reference/DependencyReporter.html index 38da704c..0769d88e 100644 --- a/docs/reference/DependencyReporter.html +++ b/docs/reference/DependencyReporter.html @@ -59,7 +59,7 @@ pkgnet - 0.2.0.9000 + 0.2.1.9000 @@ -123,7 +123,9 @@

Examp reporter <- DependencyReporter$new() # Seed it with a package -reporter$set_package("ggplot2")
#> INFO [2018-04-30 17:20:57] Resetting cached network information...
+reporter$set_package("ggplot2")
#> INFO [2018-11-01 21:48:43] Checking installed packages... +#> INFO [2018-11-01 21:48:43] Found 'ggplot2' in installed packages. +#> INFO [2018-11-01 21:48:43] Resetting cached network information...
# plot it up reporter$plot_network()
#> Error in eval(expr, envir, enclos): attempt to apply non-function
diff --git a/docs/reference/FunctionReporter.html b/docs/reference/FunctionReporter.html index eb3294d5..d7cc5775 100644 --- a/docs/reference/FunctionReporter.html +++ b/docs/reference/FunctionReporter.html @@ -28,7 +28,7 @@ @@ -60,7 +60,7 @@ pkgnet - 0.2.0.9000 + 0.2.1.9000 @@ -102,7 +102,7 @@

Package Function Reporter Class

This Reporter takes a package and uncovers the structure from - its other functions, determining useful information such as which function is most + its other functions, determining useful information such as which function is most central to the package. Combined with testing information it can be used as a powerful tool to plan testing efforts.

@@ -118,7 +118,7 @@

pkgnet - 0.2.0.9000 + 0.2.1.9000 diff --git a/docs/reference/doc_shared.html b/docs/reference/doc_shared.html new file mode 100644 index 00000000..14eff5b9 --- /dev/null +++ b/docs/reference/doc_shared.html @@ -0,0 +1,149 @@ + + + + + + + + +NULL Object For Common Documentation — doc_shared • pkgnet + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

NULL Object For Common Documentation

+ Source: R/pkgnet.R +
+ + +

This is a NULL object with documentation so that later functions can call +inheritParams

+ + + +

Arguments

+ + + + + + + + + + +
pkg_name

(string) name of a package

pkg_path

(string) The path to the package repository. If given, coverage +will be calculated for each function. pkg_path can be an +absolute or relative path.

+ + +
+ +
+ +
+
+

Developed by Brian Burns, James Lamb.

+
+ +
+

Site built with pkgdown.

+
+ +
+
+ + + + + + diff --git a/docs/reference/index.html b/docs/reference/index.html index b5f9cd7d..258f0391 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -54,7 +54,7 @@ pkgnet - 0.2.0.9000 + 0.2.1.9000 @@ -103,7 +103,7 @@

Reference

-

All functions

+

All Functions

@@ -157,7 +157,7 @@

Contents

 diff --git a/man/AbstractGraphReporter.Rd b/man/AbstractGraphReporter.Rd index 4b5c7503..a01b8a8f 100644 --- a/man/AbstractGraphReporter.Rd +++ b/man/AbstractGraphReporter.Rd @@ -42,4 +42,5 @@ Defines the Abstract Class for all PackageGraphReporters defined in pkgnet. \seealso{ Other AbstractReporters: \code{\link{AbstractPackageReporter}} } +\concept{AbstractReporters} \keyword{datasets} diff --git a/man/AbstractPackageReporter.Rd b/man/AbstractPackageReporter.Rd index 726e76cb..b9b624bc 100644 --- a/man/AbstractPackageReporter.Rd +++ b/man/AbstractPackageReporter.Rd @@ -41,4 +41,5 @@ Defines the Abstract Class for all PackageReporters defined in pkgnet. \seealso{ Other AbstractReporters: \code{\link{AbstractGraphReporter}} } +\concept{AbstractReporters} \keyword{datasets} diff --git a/man/DependencyReporter.Rd b/man/DependencyReporter.Rd index 2d0e93cf..4948d267 100644 --- a/man/DependencyReporter.Rd +++ b/man/DependencyReporter.Rd @@ -30,4 +30,5 @@ reporter$plot_network() Other PackageReporters: \code{\link{FunctionReporter}}, \code{\link{SummaryReporter}} } +\concept{PackageReporters} \keyword{datasets} diff --git a/man/FunctionReporter.Rd b/man/FunctionReporter.Rd index 61651baf..f48c5a7b 100644 --- a/man/FunctionReporter.Rd +++ b/man/FunctionReporter.Rd @@ -38,4 +38,5 @@ This Reporter takes a package and uncovers the structure from Other PackageReporters: \code{\link{DependencyReporter}}, \code{\link{SummaryReporter}} } +\concept{PackageReporters} \keyword{datasets} diff --git a/man/SummaryReporter.Rd b/man/SummaryReporter.Rd index 926bc245..5cf92161 100644 --- a/man/SummaryReporter.Rd +++ b/man/SummaryReporter.Rd @@ -42,4 +42,5 @@ Defines a concrete implementation of \link{AbstractPackageReporter} Other PackageReporters: \code{\link{DependencyReporter}}, \code{\link{FunctionReporter}} } +\concept{PackageReporters} \keyword{datasets} diff --git a/man/doc_shared.Rd b/man/doc_shared.Rd new file mode 100644 index 00000000..cb82a9e0 --- /dev/null +++ b/man/doc_shared.Rd @@ -0,0 +1,16 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/pkgnet.R +\name{doc_shared} +\alias{doc_shared} +\title{NULL Object For Common Documentation} +\arguments{ +\item{pkg_name}{(string) name of a package} + +\item{pkg_path}{(string) The path to the package repository. If given, coverage +will be calculated for each function. \code{pkg_path} can be an +absolute or relative path.} +} +\description{ +This is a NULL object with documentation so that later functions can call +inheritParams +}