Skip to content

[R] Use roxygen @examplesIf tag in R docs #27696

@asfimport

Description

@asfimport

The development version of roxygen2 supports a new tag @examplesIf to include examples conditionally: r-lib/roxygen2@513c9e2

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.

Reporter: Ian Cook / @ianmcook
Assignee: Nicola Crane / @thisisnic

Related issues:

PRs and other links:

Note: This issue was originally created as ARROW-11849. Please see the migration documentation for further details.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions