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

Update links in the vignettes #65

Open
alnajar opened this issue Aug 1, 2023 · 5 comments
Open

Update links in the vignettes #65

alnajar opened this issue Aug 1, 2023 · 5 comments

Comments

@alnajar
Copy link

alnajar commented Aug 1, 2023

The links that refer to other vignettes are broken and need updates

For example:
image

They refer to
https://cran.r-project.org/web/packages/tidyREDCap/doc/importInstruments.html

should be

https://cran.r-project.org/web/packages/tidyREDCap/vignettes/import_instruments.html

@anbrav0
Copy link

anbrav0 commented May 3, 2024

Hello,

just commenting on this issue as I encountered a broken link in a vignette: https://cran.r-project.org/web/packages/tidyREDCap/vignettes/import_instruments.html

image

the broken link is referred in the section: "See the Importing from REDCap vignette for details/information for saving your API key in the .Renviron file"

broken_link

@RaymondBalise
Copy link
Owner

Thank you for the heads up @anbrav0. Did you happen to check the link from inside of the package itself?

@anbrav0
Copy link

anbrav0 commented May 3, 2024

thank you for the response @RaymondBalise , yes, the link works from inside the package. I had been referring colleagues to webpage so I'll let them know about the workaround

@RaymondBalise
Copy link
Owner

Thanks for the feedback. I will need to think of a fix so the cross reference will work in both the package and on the web. I just tested it on the website for the package and it is broken there also... back to the drawing board. :)

@anbrav0
Copy link

anbrav0 commented May 3, 2024

seems like the vignette related to API connection exists (works) in the articles section of the website here @RaymondBalise : https://raymondbalise.github.io/tidyREDCap/articles/useAPI.html

and through this path here on CRAN:
https://cran.r-project.org/web/packages/tidyREDCap/vignettes/useAPI.html

but not when referred to docs here:
https://cran.r-project.org/web/packages/tidyREDCap/doc/useAPI.html

maybe a possible workaround can also be hard directing the link to the vignettes
image

thank you to the team for your work on this package

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants