listModules: Tools for examining modules on known repositories

In PredictiveEcology/SpaDES.project: Project Templates Using 'SpaDES'

Tools for examining modules on known repositories

Description

When exploring existing modules, these tools help identify and navigate modules and their interdependencies.

Usage

listModules(
  keywords,
  accounts,
  includeForks = FALSE,
  includeArchived = FALSE,
  excludeStale = TRUE,
  omit = c("fireSense_dataPrepFitRas"),
  purge = FALSE,
  returnList = FALSE,
  verbose = getOption("Require.verbose", 1L)
)

moduleDependencies(
  modules,
  modulePath = getOption("reproducible.modulePath", ".")
)

moduleDependenciesToGraph(md)

PlotModuleGraph(graph)

Arguments

keywords	A vector of character strings that will be used as keywords for identify modules
accounts	A vector of character strings identifying GitHub accounts e.g., PredictiveEcology to search.
includeForks	Should the returned list include repositories that are forks (i.e., not the original repository). Default is FALSE.
includeArchived	Should the returned list include repositories that are archived (i.e., developer has retired them). Default is FALSE.
excludeStale	Logical or date. If TRUE, then only repositories that are still active (commits in the past 2 years) are returned. If a date (e.g., "2021-01-01"), then only repositories with commits since that date are returned. Default is TRUE, i.e., only include active in past 2 years.
omit	A vector of character strings of repositories to ignore.
purge	There is some internal caching that occurs. Setting this to TRUE will remove any cached data that is part of the requested accounts and keywords.
returnList	Should the function return a named list where the name is the account and the elements are the repositories selected. Default FALSE, i.e., return a character vector. This is included to allow a user to maintain backwards compatibility by setting returnList = TRUE
verbose	Numeric or logical indicating how verbose should the function be. If -1 or -2, then as little verbosity as possible. If 0 or FALSE, then minimal outputs; if 1 or TRUE, more outputs; 2 even more. NOTE: in Require function, when verbose >= 2, also returns details as if returnDetails = TRUE (for backwards compatibility).
modules	Either a character vector of local module names, or a named list of character strings of short module names (i.e., the folder paths in modulePath).
modulePath	A character string indicating the path where the modules are located.
md	A data.table with columns from and to, showing relationships of objects in modules. Likely from moduleDependencies.
graph	An igraph object to plot. Likely returned by moduleDependenciesToGraph.

Value

listModules returns a character vector of paste0(account, "/", Repository) for all SpaDES modules in the given repositories with the accounts and keywords provided.

See Also

metadataInModules() helps to see different metadata elements in a folder of modules.

Examples

listModules(accounts = "PredictiveEcology", "none")

PredictiveEcology/SpaDES.project documentation built on Dec. 23, 2024, 7:33 a.m.