broken links to MotrpacRatTraining6moData objects

[nicolerg]

References to data objects in MotrpacRatTraining6moData within documentation for MotrpacRatTraining6mo are broken.

For example, see links here.

Something that should be https://motrpac.github.io/MotrpacRatTraining6moData/reference/TISSUE_ABBREV.html is https://rdrr.io/pkg/MotrpacRatTraining6moData/man/TISSUE_ABBREV.html (broken)

[nicolerg]

@bcjaeger how did you get your documentation on rdrr.io? e.g. https://rdrr.io/github/bcjaeger/orsf2/man/aorsf-package.html

[bcjaeger]

Howdy! I'm not sure exactly how rdrr knows that aorsf is an R package but doesn't know MotrpacRatTraining6moData is one. It should incorporate all R packages on GitHub automatically.

I would try usethis::use_package_doc() to make a file for package-level documentation. This may be how rdrr identifies R packages on GitHub.

[bcjaeger]

My personal experience with links in R packages is that they are often unreliable. However, links to pages on your pkgdown website are much more reliable.

E.g., I think putting a link to https://motrpac.github.io/MotrpacRatTraining6moData/reference/ASSAY_ABBREV.html in your docs will be more reliable than rdrr or another source. Since roxygen lets you do markdown syntax, you can make the links look less crazy the normal way, e.g., see ASSAY_ABBREV documentation

[nicolerg]

Thank you! I think I found the solution here, i.e. add the GitHub pages URL to both DESCRIPTION and _pkgdown.yml. Working on it...

[nicolerg]

Unfortunately neither adding the pkgdown site URLs and rebuilding nor adding the file generated by usethis::use_package_doc() resolved this. I submitted r-lib/pkgdown#2203 asking about cross-package linking and rdrr-io/rdrr-issues#103 asking how/if these packages can be added to https://rdrr.io/.

[nicolerg]

Resolved! Possibly by updating pkgdown and downlit? But creating the pkgdown website with the GitHub Action resolved this.