https://github.com/pharmaverse/admiraltemplate

Recommended Structure for admiral R package extensions
https://github.com/pharmaverse/admiraltemplate

Last synced: 3 months ago
JSON representation

Recommended Structure for admiral R package extensions

• Host: GitHub
• URL: https://github.com/pharmaverse/admiraltemplate
• Owner: pharmaverse
• License: apache-2.0
• Created: 2022-04-14T17:59:03.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-19T15:22:48.000Z (4 months ago)
• Last Synced: 2024-07-19T19:46:32.166Z (4 months ago)
• Language: R
• Homepage: https://pharmaverse.github.io/admiraltemplate/
• Size: 8.46 MB
• Stars: 4
• Watchers: 4
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS.md
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• jimsghstars - pharmaverse/admiraltemplate - Recommended Structure for admiral R package extensions (R)

README

        


# admiral package extension Template 

[](https://pharmaverse.org)

[![CRAN

status](https://www.r-pkg.org/badges/version/admiral)](https://CRAN.R-project.org/package=admiral)

[![Test

Coverage](https://raw.githubusercontent.com/pharmaverse/admiraltemplate/badges/main/test-coverage.svg)](https://github.com/pharmaverse/admiraltemplate/actions/workflows/code-coverage.yml)

## Table of Contents

-   [Extension Expectations](#extension-expectations)

-   [What is included in the

    template](#what-is-included-in-the-template)

-   [Package Extension Guidance](#package-extension-guidance)

-   [Quick Start Guide for Template](#quick-start-guide-for-template)

## Extension Expectations

To be included as an `{admiral}` package extension we expect developers

to adhere to the following standards:

-   [Code of

    Conduct](https://pharmaverse.github.io/admiral/CODE_OF_CONDUCT.html)

-   [Manifesto](https://pharmaverse.github.io/admiral/index.html?q=manifest#admiral-manifesto)

-   [Programming

    Strategy](https://pharmaverse.github.io/admiraldev/articles/programming_strategy.html)

-   Follow consistent workflow checks

-   A CRAN Release means 90% or greater test coverage

We have developed this repository template in order to reduce the burden

on developers to follow these standards. This template will also help to

harmonize the `{admiral}` family of R packages, to ensure a consistent

user experience and ease of installing and adopting all the packages.

With this in mind, we expect the same core package dependencies and

versions as used for `{admiral}`.

## What is included in the template

The repository template includes the following:

-   License file (Apache 2.0 - but company co-developers need to be

    added to copyright section)

-   Required folders (R; test; templates; vignettes; etc)

-   Set-up files (DESCRIPTION; NAMESPACE; etc)

-   Issue Templates (Bug Template; Feature Request; Documentation

    Request/Update; Onboarding)

-   Pull Request Template

-   Workflow actions (a selection of generic and specific CI/CD

    auto-checks)

-   Package badges (Test coverage; etc)

-   Branch protection rules

## Package Extension Guidance

For detailed information regarding the ethos of `{admiral}` package

extensions and how to decide if you should set your own one up, please

see our [Package Extension

Guidance](https://pharmaverse.github.io/admiraldev/articles/package_extensions.html).

You will also find details about team setup, suggested workflow and

lessons learned from past package extensions.