Skip to content
Snippets Groups Projects
title: "Development actions history"
author: "Ghislain DURIF"
output: html_document
editor_options: 
  chunk_output_type: console

Package init and setup: funStatTest

Package description and meta-data

# DESCRIPTION
fusen::fill_description(
  pkg = here::here(),
  fields = list(
    Title = "Statistical testing for functional data",
    Description = "Write me.",
    `Authors@R` = c(
      person("Zaineb", "Smida", email = "FixMe", 
             role = c("aut", "cre"), comment = c(ORCID = "FixMe")),
      person("Ghislain", "Durif", email = "gd.dev@libertymail.net", 
             role = c("aut"), comment = c(ORCID = "0000-0003-2567-1401"))
    )
  )
)
# License
usethis::use_agpl_license()

Initial setup (to be run once)

Development framework

# use git
usethis::use_git()
# deal with classical files to ignore
usethis::git_vaccinate()
# ignore .git sub-directory when building
usethis::use_build_ignore(".git")

Extra documentation

# README
usethis::use_readme_rmd()
# package-level documentation
usethis::use_package_doc()

Misc

# additional files/folders to ignore during build
usethis::use_build_ignore("draft")

Package development tools

Document and check

# 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 source package

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