Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CRAN: R CMD check note #1420

Closed
3 tasks done
llrs-roche opened this issue Nov 21, 2024 · 1 comment · Fixed by #1427
Closed
3 tasks done

CRAN: R CMD check note #1420

llrs-roche opened this issue Nov 21, 2024 · 1 comment · Fixed by #1427
Assignees
Labels
bug Something isn't working core

Comments

@llrs-roche
Copy link
Contributor

What happened?

The documentation has some problems on multiple flavors; r-devel-linux-x86_64-debian-clang, r-devel-linux-x86_64-debian-gcc, r-devel-windows-x86_64:

Found the following Rd file(s) with Rd \link{} targets missing package
  anchors:
    TealReportCard.Rd: ReportCard
    init.Rd: teal_data
    module_teal_with_splash.Rd: teal_data
  Please provide package anchors for all Rd \link{} targets not in the
  package itself and the base packages.

This might be related to the same issues on teal.data insightsengineering/teal.data#335

sessionInfo()

No response

Relevant log output

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct.

Contribution Guidelines

  • I agree to follow this project's Contribution Guidelines.

Security Policy

  • I agree to follow this project's Security Policy.
@llrs-roche llrs-roche added bug Something isn't working core labels Nov 21, 2024
@llrs-roche
Copy link
Contributor Author

This kind of issues (insightsengineering/teal.data#335, insightsengineering/teal.modules.clinical#1231, insightsengineering/teal.osprey#284) are due to links not providing the correct target:

Instead of using [func()] on the roxgygen2 comment which triggers the NOTE we should use [pkg::func()] that produces \code{\link[pkg:func]{pkg::func()}} which can be resolved by R when creating the links on the html.
The current approach produces \code{\link[=func]{func()}}, which means func() should be exported & documented on the same package where it is used.

@llrs-roche llrs-roche self-assigned this Dec 11, 2024
llrs-roche added a commit to insightsengineering/teal.data that referenced this issue Dec 11, 2024
# Pull Request

Fixes #335 

The links are correctly resolved to the package and `R CMD check`
doesn't complain (with 2024-12-07 r87428 ucrt)

See
insightsengineering/teal#1420 (comment)
for a longer explanation.
llrs-roche added a commit to insightsengineering/teal.osprey that referenced this issue Dec 11, 2024
# Pull Request

Fixes #284 

I removed a link and resolved one manually to CRAN.
`R CMD check` doesn't complain (with 2024-12-07 r87428 ucrt).

Lintr didn't detect any issue

See
insightsengineering/teal#1420 (comment)
for a longer explanation.

---------

Co-authored-by: 27856297+dependabot-preview[bot]@users.noreply.github.com <27856297+dependabot-preview[bot]@users.noreply.github.com>
llrs-roche added a commit to insightsengineering/teal.modules.clinical that referenced this issue Dec 11, 2024
# Pull Request

Fixes #1231 

The links are correctly resolved to the package and R CMD check doesn't
complain (with 2024-12-07 r87428 ucrt)

See
insightsengineering/teal#1420 (comment)
for a longer explanation.

---------

Co-authored-by: 27856297+dependabot-preview[bot]@users.noreply.github.com <27856297+dependabot-preview[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working core
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant