Set up, or migrate to a muggle project. Wraps the following steps, if the respective files or configuration do not already exist:
Package Structure: Sets up scaffolding via
usethis::create_package() and asks the user to complete the
Editors/IDEs: Sets up vscode (
use_vscode()) and RStudio as editors.
Git/GitHub: Initialises a git repo via
usethis::use_git(), creates a repo on GitHub and sets it as an origin remote.
README: Adds a
usethis::use_readme_md() and asks the user to complete it.
Testing: Sets up the project for unit tests via
usethis::use_testthat() and test coverage via
Documentation: Sets up markdown support in roxygen via
usethis::use_roxygen_md(), package documentation via
usethis::use_package_doc() and ddds a pkgdown website via
Workflow Automation: sets up caching at lib_cache_path and tba.
Compute Environment: tba.
Arguments passed on to
Must not be run inside a package, but at the root of all packages
If run on an existing project, the project should be under version control, with a clean working tree. The user should check all changes.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.