create_pkg: Create a Bioconductor Hub package

In Bioconductor/HubPub: Utilities to create and use Bioconductor Hubs

Create a Bioconductor Hub package

Description

This function creates the skeleton of a package that follow the guidelines for Bioconductor type packages. It is expected of the user to go through and make any necessary changes or improvements once the package begins to take shape. For examples, the DESCRIPTION contains very basic requirements, but the developer should go back and fill in the 'Title:' and 'Description:' fields.

Usage

create_pkg(package, type = c("AnnotationHub", "ExperimentHub"), use_git = TRUE)

Arguments

package	A character(1) with the path of the package to be created.
type	A character(1) to indicate what type of hub package is to be created. Either AnnotationHub or ExperimentHub are acceptable.
use_git	A logical(1) indicating whether to set up git using usethis::use_git(). Default is set to TRUE.

Value

Path to package location

Examples

fl <- tempdir()
create_pkg(file.path(fl, "tstPkg"), "AnnotationHub")

Bioconductor/HubPub documentation built on Nov. 1, 2024, 11:02 p.m.