Skip to content

version 0.4.0

Compare
Choose a tag to compare
@bburns632 bburns632 released this 06 Apr 01:48
948df89

NEW FEATURES

  • Objects of new DirectedGraph class now slot into the pkg_graph field of network reporters. These objects encapsulate the graph modeling of networks and have a more expressive set of methods for analysis. Check out the full documentation with ?DirectedGraph. (#181)
    • Use pkg_graph$node_measures and pkg_graph$graph_measures to respectively calculate node-level and graph-level measures.
    • Use pkg_graph$default_node_measures and pkg_graph$default_graph_measures to see the measures calculated by default.
    • Use pkg_graph$available_node_measures and pkg_graph$available_graph_measures to see the all supported measures.
    • The igraph object is now instead available at pkg_graph$igraph.
  • pkgnet now has a gallery! Check out reports for different packages. We welcome contributions---see here for instructions on how to add a package to the gallery.
  • New function CreatePackageVignette that creates an Rmarkdown HTML vignette version of a pkgnet report. This vignette can be built using knitr and distributed with a package, like any other vignette. Check out our example on the pkgnet gallery. (#200)
  • Roxygen documentation has been improved. Each reporter's documentation is now more complete. Additionally, there is a new package documentation article that introduces pkgnet, accessible with ?pkgnet. (#192, #193, #198)

CHANGES

  • Standardizing on the language "dependency" and "reverse dependency" to describe the directed graph relationships in the package. This completes the change introduced in v0.3.0 where edge direction convention was set to point in the direction of dependency. So this means that "depend on" follows the edge arrow direction, and "reverse depends on" is reverse edge arrow direction. (#191, #181)
  • outSubgraphSize and inSubgraphSize have been replaced with numRecursiveDeps and numRecursiveRevDeps, which are the former minus one (by not counting the node itself). (#191, #181)
  • Per the new DirectedGraph feature, reporters' pkg_graph field now contain an object of new DirectedGraph class. Previously it held an igraph object. This igraph object is now instead available at pkg_graph$igraph. See NEW FEATURES section for other details about the new pkg_graph object. (#181)
  • Default measures now exist for each reporter. These can be calculated with the
    new method calculate_default_measures on reporters. (#181)
    • The report from CreatePackageReport will now only show default measures.
  • Reporters now only allow packages to be set once. To report on a new package, please instantiate a new instance of the reporter of interest. (#106, #181)
  • The report from CreatePackageReport now prints the version of pkgnet used at the bottom. (#181)
  • AbstractPackageReporter and AbstractGraphReporter are no longer exported. These are base classes that are not meant to be used directly. (#190, #198)
  • Wide in package reports are now horizontally scrollable instead of making the page wider. (#200)

BUG FIXES

  • Static outputs shown in the vignette that were outdated have been updated. (#189, #181)