Refactor: update API for network_p2p() #228
Merged
Merged
Conversation
examples in question were taking too long to run during package checks, causing warnings to be generated. By moving them under `donttest`, they will be excluded from the package checks while still being included in the package documentation.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This branch overhauls the API design and features of
network_p2p()in order to make the function usage more intuitive, and to add in the additional features around calculating network centrality. This branch mainly addresses #225. The version is also updated tov1.9.0, and a version has been pushed to CRAN.In the commit history,
network_p2p_test()is added as a temporary draft of the originalnetwork_p2p()function to enable easier testing and troubleshooting.Changes
The changes made in this PR are:
network_p2p()network_p2p()now has acentralityargument for computing and visualizing centrality as node sizes in the network plotalgorithmargument is renamed tolayoutfor better intuitivenessstyleargument now controlling the network plotting mechanism andreturnargument controlling whether plots are generated interactively or saved as PDFigraphnetwork_louvain()andnetwork_leiden()have been removed.network_summary()network_summary()adds the ability to return pagerank.create_dtThis version also includes some minor dependency maintenance done to
create_dt().Checks
roxygen2::roxygenise()has been run prior to merging to ensure that.RdandNAMESPACEfiles are up to date.NEWS.mdhas been updated.Notes
This fixes #225.