Package 'rodev'

Title: Helper for rOpenSci Package Developpers
Description: Provides helpers for rOpenSci package developpers, mostly helping with metadata management (badges, DESCRIPTION) and GitHub infrastructure (GitHub issue and PR templates).
Authors: Maëlle Salmon [aut, cre] , Daniel Possenriede [ctb] , rOpenSci [fnd] (https://ropensci.org/)
Maintainer: Maëlle Salmon <[email protected]>
License: GPL-3
Version: 0.0.1.900
Built: 2025-03-12 03:28:40 UTC
Source: https://github.com/ropenscilabs/rodev

Help Index


Add rOpenSci review mention to DESCRIPTION (no longer recommended)

Description

No longer recommended!

Usage

add_ro_desc(path = usethis::proj_get())

Arguments

path

path to package


Add rOpenSci as funder to DESCRIPTION

Description

Add rOpenSci as funder to DESCRIPTION

Usage

add_ro_fnd(path = usethis::proj_get())

Arguments

path

path to package


Browse packaging guidelines

Description

Browse packaging guidelines

Usage

read_pkg_guide()

Names and Markdown code of repostatus.org badges

Description

Names, Markdown code, href and src of repostatus.org badges as retrieved from https://github.com/jantman/repostatus.org/tree/master/badges/latest before this package release. See also http://www.repostatus.org/ The data is distributed with a CC-BY SA license. Refer to http://www.repostatus.org/

Format

A data.frame with columns status (lowercase) and md_code.

Source

http://www.repostatus.org/


Use CRAN checks badge

Description

Use CRAN checks badge

Usage

use_cchecks_badge()

Value

It will help you add the CRAN checks badge to your README.

Examples

## Not run: 
use_cchecks_badge()

## End(Not run)

Use repostatus.org Badge

Description

Use repostatus.org Badge

Usage

use_repostatus_badge(status)

Arguments

status

current status of the project, cf details.

Details

Possible statuses are rodev::repostatus_badges$status,

  • abandoned

  • active

  • concept

  • inactive

  • moved

  • suspended

  • unsupported

  • wip

For more details refer to https://www.repostatus.org.

Value

It will help you add the repostatus.org badge to your README.

Examples

## Not run: 
use_repostatus_badge("wip")

## End(Not run)

Use rOpenSci review badge

Description

Use rOpenSci review badge

Usage

use_review_badge(onboarding_issue_id)

Arguments

onboarding_issue_id

Issue number of the onboarding thread of your package

Value

It will help you add the rOpenSci review badge to your README.

Examples

## Not run: 
use_review_badge(24)

## End(Not run)

Add collaboration files in .github

Description

Add issue, PR templates and CONTRIBUTING.md file in .github

Usage

use_ro_github(
  package_name = desc::desc_get_field("Package", file = usethis::proj_get())
)

Arguments

package_name

Package name