docs: guard bacondecomp examples with requireNamespace (#260)#262
Open
LeonidasZhak wants to merge 2 commits into
Open
docs: guard bacondecomp examples with requireNamespace (#260)#262LeonidasZhak wants to merge 2 commits into
LeonidasZhak wants to merge 2 commits into
Conversation
Wrap the main @examples blocks of fetwfe() and betwfe() in if (requireNamespace('bacondecomp', quietly = TRUE)) so that example(fetwfe) / example(betwfe) does not error for users who do not have bacondecomp installed. Fixes gregfaletto#260.
…p-examples-260 # Conflicts: # R/betwfe_core.R # R/fetwfe.R # man/betwfe.Rd # man/fetwfe.Rd
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
Wraps the main
@examplesblocks offetwfe()andbetwfe()inif (requireNamespace("bacondecomp", quietly = TRUE)) { ... }so thatexample(fetwfe)/example(betwfe)does not error for users who do not havebacondecompinstalled.Fixes #260.
Changes
R/fetwfe.R: Wrapped the main fetwfe() example block in requireNamespace guardR/betwfe_core.R: Wrapped the main betwfe() example block in requireNamespace guardman/*.Rd: Regenerated by roxygen2Validation
tools::checkRd()passes for both man pagesR CMD check --no-manual --no-vignettes --no-testsexamples check: OK