Nothing
All commands that you use to use when developing packages...
# Describe your package fusen::fill_description( pkg = here::here(), fields = list( Title = "Build A Package From Rmarkdown File", Description = "Use Rmarkdown First method to build your package. Start your package with documentation. Everything can be set from a Rmarkdown file in your project.", `Authors@R` = c( person("John", "Doe", email = "john@email.me", role = c("aut", "cre"), comment = c(ORCID = "0000-0000-0000-0000")) ) ) ) # Define License with use_*_license() usethis::use_mit_license("John Doe")
Either use this GitHub all-in-one function or choose the steps one-by-one in the following sections.
See vignette("share-on-a-github-website", package = "fusen")
for more information.
# _All-in-one share of your package and its documentation on GitHub fusen::init_share_on_github()
usethis::use_git() # Deal with classical files to ignore usethis::git_vaccinate() # Use main for primary branch usethis::git_default_branch_rename()
# Install a first time remotes::install_local() # README usethis::use_readme_rmd() # Code of Conduct usethis::use_code_of_conduct("contact@fake.com") # NEWS usethis::use_news_md() # Package structure (add this in a dev/Readme.md file) fusen::draw_package_structure()
From now, you will need to "inflate" your package at least once to be able to use the following commands. Let's go to your flat template, and come back here later if/when needed.
# Pipe usethis::use_pipe() # package-level documentation usethis::use_package_doc() # GitHub # Add your credentials for GitHub usethis::create_github_token() gitcreds::gitcreds_set() # _Or one step at a time # Send your project to a new GitHub project (included in `init_share_on_github()`) usethis::use_github() # Set Continuous Integration # _GitHub (included in `init_share_on_github()`) usethis::use_github_action_check_standard() usethis::use_github_action("pkgdown") usethis::use_github_action("test-coverage") # _GitLab gitlabr::use_gitlab_ci(type = "check-coverage-pkgdown")
# Simulate package installation pkgload::load_all() # Generate documentation and deal with dependencies attachment::att_amend_desc() # Check the package devtools::check() # Add a new flat template fusen::add_flat_template("add")
# set and try pkgdown documentation website locally usethis::use_pkgdown() pkgdown::build_site() # build the tar.gz with vignettes to share with others devtools::build(vignettes = TRUE) # Share your package and its documentation on GitHub # usethis::create_github_token() # gitcreds::gitcreds_set() fusen::init_share_on_github()
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.