Skip to content

Conversation

@dajmcdon
Copy link
Contributor

Changes are in the commit messages.

* rebuild it with `devtools::render_readme()`
* easier to track changes / multiple files
* Note that the rebuilt figure looks a bit different.
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was hoping there was a way to generate the README from an rmd, thanks!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does devtools::document() or check automatically run devtools::render_readme()?

Copy link
Contributor Author

@dajmcdon dajmcdon Sep 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should be an action to do build it automatically, but I couldn't find it. I know I've seen it used elsewhere though.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not that I know of.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have a handy Makefile with some chore commands, I guess in absence of something R-built-in, we use that

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yea, looks like they noped out of doing it auto

Copy link
Contributor

@dshemetov dshemetov Sep 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh in a comment there, found usethis::use_readme_rmd(), but it just builds the skeleton README.rmd and writes a git pre-commit hook

@dshemetov dshemetov changed the base branch from dev to ar/release-fixes September 12, 2023 18:09
@dshemetov dshemetov merged commit 8448da4 into ar/release-fixes Sep 12, 2023
@dshemetov dshemetov deleted the djm/pkgdown-updates branch September 12, 2023 18:17
@dsweber2 dsweber2 added this to the Z: epidatr & epidatpy milestone Oct 23, 2023
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

Successfully merging this pull request may close these issues.

4 participants