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

pkgdown site #7

Closed
topepo opened this issue Jan 6, 2021 · 4 comments
Closed

pkgdown site #7

topepo opened this issue Jan 6, 2021 · 4 comments

Comments

@topepo
Copy link
Contributor

topepo commented Jan 6, 2021

If you were to implement a pkgdown site, we could include your recipe step in the function reference on tidymodels.org.

There are some easy functions to set this up to run automatically, such as usethis::use_github_action("pkgdown"). I can help if you need to get it configured.

@petersonR
Copy link
Owner

I'd be happy to implement a pkgdown site. I used the usethis function you mentioned, but I'm a little unsure how to complete the set up from here. Is it as simple as editing a few lines in the .github/workflows/pkgdown.yaml file? If not, can I take you up on your offer of help to get it configured? Or, if you could point me to a tutorial in doing so, that works too. Thanks!

@topepo
Copy link
Contributor Author

topepo commented Mar 9, 2021

Now I suggest using usethis::use_tidy_github_actions(); it sets up a lot of stuff in general. We've started using the pak package for installs; it really cuts down on the random errors using install.packages(). That's new so you might want to re-create them.

After that, you can go to the settings and look for GitHub Pages. From there, use

image

and, after about 15 min, use this option:

image

The link to the site would then be https://petersonR.github.io/bestNormalize. You should put that in the URL field of the DESCRIPTION file after the current url.

One detail: when you have a .9000-ish version number, it puts the files in a dev path. For example, the non-9000 link would look like https://pkgdown.r-lib.org/ while the dev version is found at https://pkgdown.r-lib.org/dev.

You might want to run the action with Version: 1.7.0 and once again with Version: 1.7.0.9999 to get both sites.

@petersonR
Copy link
Owner

Thanks for the suggestions! I've used the usethis package and set up a lot of stuff, as you said. I tried to implement the pak package, but got an odd error when trying to do so. I will update the version to 1.8.0 soon, and release the non-dev version of the packagedown website at that time and close this issue. Hopefully with the new website, this can be added to tidymodels.org? Let me know if there's more I can do to help set that up.

@petersonR
Copy link
Owner

Version 1.8.0 now published to CRAN and pkgdown documentation is up: https://petersonr.github.io/bestNormalize/. Please let me know if there's anything else I can do to help get this onto the tidymodels.org recipes list - for now though I'm going to close this.

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

2 participants