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

auto-readme? #2

Open
cole-brokamp opened this issue Dec 22, 2021 · 0 comments
Open

auto-readme? #2

cole-brokamp opened this issue Dec 22, 2021 · 0 comments
Assignees

Comments

@cole-brokamp
Copy link
Member

cole-brokamp commented Dec 22, 2021

Inside of a README.Rmd, we could do

dmd <- dht::get_degauss_metadata_from_dockerfile()
ex_call <- glue::glue("docker run --rm -v $PWD:/tmp degauss/{dmd['degauss_name']}:{dmd['degauss_version']} my_address_file_geocoded.csv")

Then, using results = 'asis' will let us generate the markdown directly so it will show up as a sh code block in README.md

cat("```sh\n", ex_call, "\n```")
  • does this have to be done with R? (other templating tools, mustache)
  • use gha or other regular job to rebuild READMEs automatically?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Archived in project
Development

No branches or pull requests

1 participant