availableWF: List Available Workflows Templates at 'systemPipeRdata'...

View source: R/dataenv.R

availableWFR Documentation

List Available Workflows Templates at systemPipeRdata package

Description

This function checks the workflow templates availability from systemPipeRdata package and also from systemPipeR Organization on GitHub.

Usage

availableWF(github = FALSE)

Arguments

github

logical. If TRUE, it will return current workflow templates available on systemPipeR Organization.

Details

Internally, this function uses the GitHub API, and there is an access limit per hour. For more details, please check: system("curl -i https://api.github.com/users/<username>").

Value

Return a list with the names of the workflows templates availabe at systemPipeRdata package. If github = TRUE, it will return an addicional data.frame with current workflow templates available on systemPipeR Organization.

Note

We are assuming that workflow templates repositories under systemPipeR Organization content the keyword "Workflow Template" on the Description section and "Topics" section, we expected "systempiper" and "release" or "development" words.

Author(s)

Daniela Cassol

See Also

genWorkenvir.

Examples

availableWF()
## Not run: 
## List Workflow Templates from \code{systemPipeR} Organization
availableWF(github = TRUE)

## End(Not run)

tgirke/systemPipeRdata documentation built on Oct. 19, 2023, 9:20 p.m.