In findanna/data.anna: Build A Package With Internal And External Data

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 = "Build A Package with internal and external data",
    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("Anna", "Mantsoki", email = "[e-mail]", role = c("aut", "cre"), comment = c(ORCID = "")),
      person(given = "FIND", role = "cph")
    )
  )
)
# Define License with use_*_license()
usethis::use_mit_license("Anna Mantsoki")

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")

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

```r

set and try pkgdown documentation website

usethis::use_pkgdown() pkgdown::build_site()

build the tar.gz to share with others

devtools::build() devtools::build_readme()

findanna/data.anna documentation built on May 6, 2022, 12:25 a.m.