Documentation for Release/v0.3.0

[bburns632]

This PR updates documentation in preparation for version 0.3.0 release on github and CRAN. I will update and add the website changes from #147 once is available.

This PR also adds a NEWS.md file to pkgnet's set of documentation. Please review this file in particular for completeness.

With this PR, here is pkgnet's set of documentation:

1. README.md - to share pkgnet's purpose and functionality to new users.
2. NEWS.md - to share changes from previous versions with current users
3. pkgdown website - to accomplish both of the above in a cohesive website.
4. cran-comments.md - to chronicle communications with CRAN around submissions.

[codecov-io]

Codecov Report

Merging #150 into master will increase coverage by 0.03%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master     #150      +/-   ##
==========================================
+ Coverage   84.66%   84.69%   +0.03%     
==========================================
  Files          10       10              
  Lines         913      915       +2     
==========================================
+ Hits          773      775       +2     
  Misses        140      140

Impacted Files	Coverage Δ
R/testing_utils.R	81.08% <100%> (+1.08%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 88b348d...2f363b7. Read the comment docs.

[jameslamb]

Looks great! 🤞 that we get accepted

[jayqi]

Left some comments for missing things in NEWS.md. Let me know if you think it would be easier for me to edit directly, since there are a bunch of things.

[bburns632]

@jayqi, please add directly.

…

On Sun, Dec 16, 2018, 10:44 PM Jay Qi ***@***.*** wrote: ***@***.**** requested changes on this pull request. Left some comments for missing things in NEWS.md. Let me know if you think it would be easier for me to edit directly, since there are a bunch of things. ------------------------------ In NEWS.md <#150 (comment)> : > @@ -0,0 +1,18 @@ +# Version 0.3.0 + +## NEW FEATURES +* `InheritanceReporter`, a reporter to surface the R6 or S4 relationships within a package. Should be: InheritanceReporter, a reporter for R6, Reference, and S4 class inheritance relationships within a package. ------------------------------ In NEWS.md <#150 (comment)> : > @@ -0,0 +1,18 @@ +# Version 0.3.0 + +## NEW FEATURES +* `InheritanceReporter`, a reporter to surface the R6 or S4 relationships within a package. +* Dropdown menu in graph visualizations for node selection. + +## CHANGES +* Edge direction reversed to align with UML class diagram convention. I think this would be more clear if you specify which it is now. Now: if A depends on B, then A->B. ------------------------------ In NEWS.md <#150 (comment)> : > @@ -0,0 +1,18 @@ +# Version 0.3.0 + +## NEW FEATURES +* `InheritanceReporter`, a reporter to surface the R6 or S4 relationships within a package. +* Dropdown menu in graph visualizations for node selection. + +## CHANGES +* Edge direction reversed to align with UML class diagram convention. +* Default node colors are now colorblind accessible. +* Function network design utilizes graphopt layout. +* Testing strategy with subpackages are now CRAN and TRAVIS compatible. +* Test package `milne` created for unit testing of `InheritanceReporter`. It's also used for testing the R6 method support in FunctionReporter. Test package milne created for unit testing of object-oriented functionality in InheritanceReporter and FunctionReporter. ------------------------------ In NEWS.md <#150 (comment)> : > @@ -0,0 +1,18 @@ +# Version 0.3.0 + +## NEW FEATURES +* `InheritanceReporter`, a reporter to surface the R6 or S4 relationships within a package. +* Dropdown menu in graph visualizations for node selection. + +## CHANGES +* Edge direction reversed to align with UML class diagram convention. +* Default node colors are now colorblind accessible. +* Function network design utilizes graphopt layout. FunctionReporter uses graphopt layout by default. Also, maybe should mention: Reporters now support all layouts available in igraph. Use grep("^layout_\\S", getNamespaceExports("igraph"), value = TRUE) to see valid options. ------------------------------ In NEWS.md <#150 (comment)> : > @@ -0,0 +1,18 @@ +# Version 0.3.0 + +## NEW FEATURES +* `InheritanceReporter`, a reporter to surface the R6 or S4 relationships within a package. +* Dropdown menu in graph visualizations for node selection. + +## CHANGES +* Edge direction reversed to align with UML class diagram convention. +* Default node colors are now colorblind accessible. +* Function network design utilizes graphopt layout. +* Testing strategy with subpackages are now CRAN and TRAVIS compatible. +* Test package `milne` created for unit testing of `InheritanceReporter`. +* Width of html reports adjust to size of screen. + Orphaned node clustering was removed in favor of using layout to better handle graphs with many orphaned nodes. ------------------------------ In NEWS.md <#150 (comment)> : > @@ -0,0 +1,18 @@ +# Version 0.3.0 + +## NEW FEATURES +* `InheritanceReporter`, a reporter to surface the R6 or S4 relationships within a package. +* Dropdown menu in graph visualizations for node selection. + +## CHANGES +* Edge direction reversed to align with UML class diagram convention. +* Default node colors are now colorblind accessible. +* Function network design utilizes graphopt layout. +* Testing strategy with subpackages are now CRAN and TRAVIS compatible. +* Test package `milne` created for unit testing of `InheritanceReporter`. +* Width of html reports adjust to size of screen. + FunctionReporter now supports non-exported functions and R6 class methods. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#150 (review)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AXZRy_WFI2FjIPYyhoxEODcw3QUdrAEcks5u5yEtgaJpZM4ZVnKS> .

[bburns632]

I made all suggested edits. In the future, feel free to suggest edits & additions directly for this type of NEWS.md update.

[bburns632]

We need to handle gif in some other means. 4.6 MB tar ball seems excessive.

Here's lubridate for perspective.

[bburns632]

This change references the gif via the raw.githubusercontent.com path. Should reduce tar ball size and allow sweet gifs on this repo's readme, pkgdown site, and CRAN (probably). I'll mention the reason for the link in the release notes to CRAN.

[bburns632]

Note, the release of pkgnet version 0.3.0 is delayed until at least 1/2/2019. Happy Holidays.

[bburns632]

Just resubmitted.

[jameslamb]

That appveyor failure is 100% my fault. Ignore it for now.

See #38 , I'll fix it soon