Request: Adding a pkgdown site?

[bschneidr]

This package looks quite useful, and I learned about it thanks to the FCSM presentation today. Thank you for sharing this as a public, open-source package.

To help users understand its functionality, it would be great to have a documentation site. In lieu of a CRAN manual or R-Universe site, a GitHub 'pkgdown' site would be helpful.

The 'usethis' package makes it easy to configure a GitHub Pages site with pkgdown to help users understand the package, and you can simply run the following code to create the 'pkgdown' site and configure a GitHub Action to automatically update the site from this GitHub repo.

library(usethis)
use_pkgdown_github_pages()

I'm happy to submit a PR for this if you would find that helpful.

[jhseeman]

hello, thanks for flagging this for us! We are in the process of making major API changes to this package and the associated documentation. We have updated the README.md to reflect these changes, which includes a link to our public documentation website that covers both tidysynthesis and syntheval.

Once we have made these major API changes to both packages, we plan to make a CRAN-ready release in Q1 of 2025, where we will have tighter coupling between the package and its documentation. In the meantime, stay tuned for updates and feel free to reach out if you're interested in contributing.