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

Add: toolchain to build packages, preview website locally, and a bonus section #19

Merged
merged 10 commits into from
Nov 10, 2024

Conversation

SaranjeetKaur
Copy link
Collaborator

@SaranjeetKaur SaranjeetKaur commented Oct 24, 2024

Fixes #15 and #18

Added instructions for setting up the development environment for building R packages on Windows, macOS, and Linux. This includes installing Rtools, Xcode, and r-base-dev respectively.

Additionally,

  • Added a GitHub Actions workflow for linting the R package using lintr.
  • Added a GitHub Actions workflow for rendering Rmarkdown files.
  • Added a bonus section on adding GitHub actions, customizing the package website, and adding a package to DESCRIPTION.
  • Added an R CMD-check badge to the README.md.
  • Removed a redundant image.
  • Added steps to preview site locally.

@SaranjeetKaur SaranjeetKaur linked an issue Oct 24, 2024 that may be closed by this pull request
@SaranjeetKaur SaranjeetKaur linked an issue Oct 24, 2024 that may be closed by this pull request
@SaranjeetKaur SaranjeetKaur changed the title Add toolchain to build packages Add: toolchain to build packages, preview website locally, and a bonus section Oct 24, 2024
@SaranjeetKaur
Copy link
Collaborator Author

SaranjeetKaur commented Oct 24, 2024

@dalonsoa - could you please review these changes? (Not sure why I am not able to add you as a reviewer here!)

Copy link

@dalonsoa dalonsoa left a comment

Choose a reason for hiding this comment

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

Very nice.

README.Rmd Show resolved Hide resolved
README.Rmd Show resolved Hide resolved
@SaranjeetKaur SaranjeetKaur merged commit b4d8736 into main Nov 10, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Building the documentation locally doesn't seem to work Rtools not found
2 participants