In CDU-data-science-team/pharmacyReporting: Generate Reports For Pharmacy Inventory Project

All commands that you use to use when developing packages...

First time just after creating the project

• Fill the following chunk to create the DESCRIPTION of your package

# Describe your package
fusen::fill_description(
  pkg = here::here(),
  fields = list(
    Title = "Generate reports for pharmacy inventory project",
    Description = "Using forecasting and stock control mechanisms",
    `Authors@R` = c(
      person("Chris", "Beeley", email = "[e-mail]", role = c("aut", "cre"))
    )
  )
)
# Define License with use_*_license()
usethis::use_mit_license("Crown copyright")

Start using git

usethis::use_git()
# Deal with classical files to ignore
usethis::git_vaccinate()

Set extra sources of documentation

# README
usethis::use_readme_rmd()
# Code of Conduct
usethis::use_code_of_conduct("[e-mail]")
# NEWS
usethis::use_news_md()

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.

Package development tools

Use once

# Pipe
usethis::use_pipe()

# package-level documentation
usethis::use_package_doc()

# Set CI
# _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")

# Add new flat template
fusen::add_flat_template("add")
fusen::add_flat_template("add", flat_name = "inventory_functions")

# add vignette
usethis::use_vignette("forecasting")
usethis::use_vignette("child")

# list all flat files for inflation
# they now live in dev

source("dev/inflate_rmd.R")

Use everytime needed

# Simulate package installation
pkgload::load_all()

# Generate documentation and deal with dependencies
attachment::att_amend_desc()

# Check the package
devtools::check()

Share the package

# set and try pkgdown documentation website
usethis::use_pkgdown()
pkgdown::build_site()

# build the tar.gz to share with others
# devtools::build()

CDU-data-science-team/pharmacyReporting documentation built on March 24, 2023, 2:32 p.m.