v0.4.0

[jhollway]

Description

2023-12-24

Package

• Major overhaul of documentation
  • Moved function description up so that it appears in tooltips
  • Split documentation of many functions to provide more space for explanation
  • Moved some functions around for more thematic documentation
• Added pkg_data() to report an overview of data contained within the package(s)
• Updated README and DESCRIPTION with new organisational affiliation: stocnet/manynet
• Updated tests to be consistent with future {ggplot2} release

Making

• Migrated play_diffusion() and play_diffusions() from {migraph}
  • Including class creation, and print(), summary(), and plot() methods
• Migrated play_learning() and play_segregation() from {migraph}
  • Including class creation, and print(), summary(), and plot() methods
• Fixed bug in create_tree() where it was not returning a two-mode network correctly

Modifying

• Added as_diffusion() to coerce a table of diffusion events into diff_model class
  • as_*() functions are now considered modifications
• Completed a full range of tidy verbs for nodes
  • Added mutate_nodes()
  • Added filter() and filter_nodes()
  • Added rename_nodes()
• Completed a full range of tidy and igraph verbs for ties
  • Added bind_ties()
  • Added delete_ties()
• Added to_tree() to find one or more spanning trees amongst a network's ties
• Added from_ties() to collect multiple networks into a multiplex network

Marking

• Renamed is.igraph() to is_igraph() for igraph v2.0.0
• Added is_list() for identifying a list of networks
• Migrated node_is_core(), node_is_cutpoint(), node_is_fold(), node_is_isolate(), node_is_mentor() from {migraph}
• Migrated node_is_exposed(), node_is_infected(), node_is_latent(), node_is_recovered() from {migraph}
• Migrated node_is_max(), node_is_min(), node_is_random() from {migraph}
• Migrated tie_is_bridge(), tie_is_loop(), tie_is_multiple(), tie_is_reciprocated() from {migraph}
• Added tie_is_feedback()
• Migrated tie_is_max(), tie_is_min() from {migraph}
• Added tie_is_random()

Mapping

• Added scale_edge_color_centres(), scale_edge_color_ethz(), scale_edge_color_iheid(), scale_edge_color_rug(), scale_edge_color_sdgs()
  • Fixed bug that meant edge scales were unavailable (closes #43)
• autographr() now provides legends by default where multiple colours are used (closes #52)
• autographs() now labels legends correctly for binary variables (closes #38)
• autographs() now graphs just the first and last networks in a list (closes #45)
• autographs() now includes an option whether the layout should be based on the first, last, or both of two networks (closes #48)

Data

• Renamed ison_konigsberg to ison_koenigsberg and named the bridges
• ison_algebra now in long multiplex format
• ison_karateka now weighted, anonymous members are named by number, and "obc" variable renamed "allegiance"
• ison_lawfirm enlarged from 36 to 71 nodes and now consists of three multiplex, directed networks
• ison_southern_women names are now title case
• Added ison_hightech, a multiplex, directed network from Krackhardt 1987
• Added four ison_monastery datasets, three of which are signed and weighted, and the other is longitudinal, from Sampson 1969 (closes #49)
• Added six ison_potter datasets in a list of networks, from Bossaert and Meidert 2013 (closes #47)
• Added ison_usstates data on the contiguity of US states, from Meghanathan 2017

Checklist:

• PR form
  • [x] Description above itemizes changes under subtitles, e.g. "## Data""
  • [x] Any closed, fixed, or related issues are referenced and explained in the description above, e.g. "Fixed #0 by adding A"
  • [x] Package builds on my OS without issues
• PR checks all pass for latest commit
  • [ ] CodeFactor check: Package improves or maintains good style
  • [x] Package builds on Mac
  • [x] Package builds on Windows
  • [x] Package builds on Linux
  • [ ] CodeCov check: Package improves or maintains good test coverage
• Documentation
  • [x] Any new or modified functions or data have roxygen style documentation in their .R scripts
  • [x] Longer functions are commented inline or broken down into helper functions so that it is easier to debug in the future
  • [x] PR description above and the NEWS.md file are aligned
  • [x] DESCRIPTION file version is bumped by the appropriate increment (major, minor, patch)

[codecov[bot]]

Codecov Report

Attention: 675 lines in your changes are missing coverage. Please review.

Comparison is base (a1769d4) 53.46% compared to head (869ebc6) 47.94%. Report is 136 commits behind head on main.

:exclamation: Current head 869ebc6 differs from pull request most recent head 17b07f4. Consider uploading reports for the commit 17b07f4 to get more accurate results

Files	Patch %	Lines
R/mark_nodes.R	13.97%	117 Missing :warning:
R/class_diff_model.R	6.12%	92 Missing :warning:
R/make_play.R	40.41%	87 Missing :warning:
R/make_read.R	62.63%	71 Missing :warning:
R/map_autographr.R	20.22%	71 Missing :warning:
R/pkg_tutorials.R	0.00%	39 Missing :warning:
R/manip_as.R	11.11%	32 Missing :warning:
R/map_theme.R	44.23%	29 Missing :warning:
R/class_marks.R	22.58%	24 Missing :warning:
R/mark_is.R	40.00%	21 Missing :warning:
... and 10 more

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #55 +/- ## ========================================== - Coverage 53.46% 47.94% -5.53% ========================================== Files 22 27 +5 Lines 3056 3604 +548 ========================================== + Hits 1634 1728 +94 - Misses 1422 1876 +454 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.