[ARROW-11849] [R] Use roxygen @examplesIf tag in R docs

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 3.0.0
• Fix Version/s: 5.0.0
• Component/s: R
• Labels: pull-request-available
• External issue URL: https://github.com/apache/arrow/issues/27696
• Assignee: Nicola Crane
• Reporter: Ian Cook
• Created: 03/Mar/21 03:39
• Updated: 11/Jan/23 08:22
• Resolved: 27/May/21 14:16

Description

The development version of roxygen2 supports a new tag @examplesIf to include examples conditionally: https://github.com/r-lib/roxygen2/commit/513c9e25262e67e7d3383a0feb51be0ba9b6e21f

Use this to remove the feature availability conditionals that are used in some examples, including:

• if (arrow_available()) {...}
• if (arrow_with_dataset()) {...}
• if (arrow_with_parquet()) {...}
• if (arrow_with_s3()) {...}

This will simplify the examples and avoid giving the misleading suggestion that users need to perform these checks this every time.

Issue Links

• relates to: ARROW-11735 [R] Allow Parquet and Arrow Dataset to be optional components
• links to: GitHub Pull Request #10373