getwilds / cancerprof

API Client for State Cancer Profiles
http://getwilds.org/cancerprof/
Other
2 stars 3 forks source link

pkgdown site? #58

Closed sckott closed 6 months ago

sckott commented 7 months ago

If there will be one https://pkgdown.r-lib.org/ ...

realbp commented 6 months ago

Yup, the package down site is created, im not sure if it is ready to be published but it is on my local storage. I am not sure what you mean by @family, I was not able to find it in the package down documentations. All of the handle functions will not be exported so it wont show in pkgdown, but I will make sure to group similar functions!

sckott commented 6 months ago

read up here for https://roxygen2.r-lib.org/articles/index-crossref.html#family family stuff

e.g. in sixtyfour package

These https://github.com/getwilds/sixtyfour/blob/main/R/bucket.R#L7 creates these https://github.com/getwilds/sixtyfour/blob/main/man/aws_bucket_delete.Rd#L37-L46 and you get see also links in your pkgdown site like this https://getwilds.org/sixtyfour/reference/aws_bucket_create.html#see-also