Skip to content

Documentation: CRAN Compliance#67

Merged
martinctc merged 42 commits into
mainfrom
docs/cran-compliance-2
Mar 5, 2021
Merged

Documentation: CRAN Compliance#67
martinctc merged 42 commits into
mainfrom
docs/cran-compliance-2

Conversation

@martinctc

@martinctc martinctc commented Feb 15, 2021

Copy link
Copy Markdown
Member

Summary

This branch implements a number of documentation changes in order to be compliant with CRAN review guidelines. This is a continuation of #54 to implement more CRAN compliance measures.

Changes

The changes made in this PR are as follows.

Relevant to CRAN checks

  1. Show return options consistently for all functions (Documentation: return options are not consistently shown #31)
  2. Recategorise 'Families' for all functions (Documentation: Fix Families #58)
  3. Address any package names that are not in single quotes in title and description (Documentation: write package names in single quotes in title and description #59)
  4. Replace usage of par() and options() with on.exit(par(old_par)) to avoid changing user options (Fix: do not change user options or par for network_p2p() #60)
  5. General documentation clean-up

Miscellaneous fixes and improvements

  1. Playbook updated to include less well-referenced functions, like meetingtype_summary() and identify_churn().
  2. Exported the active_threshold argument to workpatterns_classify(), which was previously only available in the internal function workpatterns_classify_bw().
  3. Exported the mingroup argument for mgrrel_matrix()

Checks

  • All R CMD checks pass
  • roxygen2::roxygenise() has been run prior to merging to ensure that .Rd and NAMESPACE files are up to date.

Notes

This fixes #31, #58, #59, and #60.

@martinctc martinctc self-assigned this Feb 15, 2021
@martinctc martinctc added the documentation Improvements or additions to documentation label Feb 15, 2021
@martinctc martinctc linked an issue Feb 22, 2021 that may be closed by this pull request
@martinctc martinctc marked this pull request as ready for review March 5, 2021 16:00
@martinctc martinctc merged commit 9a6192f into main Mar 5, 2021
@martinctc martinctc deleted the docs/cran-compliance-2 branch March 5, 2021 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

2 participants