Should we remove {roxygen2} documentation for internal functions

[villegar]

Background

Some internal functions like append_entity_ref (full list below) have {roxygen2} documentation, but are only for internal use. These functions should not be displayed on the package documentation webpage, PDF, etc. However, when the documentation is rendered by CRAN: https://cran.r-project.org/web/packages/dsROCrate/refman/dsROCrate.html, these internal functions are rendered. On the other hand, when the documentation website is generated with {pkgdown} this is not an issue: https://federatedmethods.github.io/dsROCrate/reference/index.html

Problem

This mismatch is because CRAN uses the function tools::Rd2pdf() to generate the package manual (website and PDF), which ignores the @keywords internal used in the internal functions.

Possible solution

Here we can either ignore the fact that the documentation linked by CRAN will include internal functions OR add the @noRd tag, which will remove the .Rd files completely, but it also means not documentation when a developer runs
?dsROCrate:::append_entity_ref.

List of internal functions with roxygen2 documentation

• append_entity_ref
• audit_engine
• dsROCrate-package
• extract_safe_data
• extract_safe_output
• extract_safe_people
• extract_safe_project
• extract_safe_setting
• flatten_safe_data
• flatten_safe_output
• flatten_safe_people
• flatten_safe_project
• flatten_safe_setting
• flatten_user_perm_entity
• get_project_details
• get_project_tables
• get_table_permissions
• is_opal_admin_con
• is_valid_posixct
• load_content
• load_cr8tor_bundle
• parse_user_profiles
• project_exists
• refill_vec
• unfill_vec
• update_project_datasets
• user_perm_entity
• validate_opal_con