build_script_df: Build Script Index Dataset

In TuCai/phuse: Web Application Framework for 'PhUSE' Scripts

Build Script Index Dataset

Description

Grep all the YML files, parse the metadata and build a data frame containing key metadata tags.

Usage

build_script_df(
  repo_url = "https://github.com/phuse-org/phuse-scripts.git",
  repo_base = "https://github.com/phuse-org/phuse-scripts/raw/master",
  repo_dir = NULL,
  work_dir = NULL,
  output_fn = NULL,
  days_to_update = 7,
  fn_only = FALSE,
  upd_opt = NULL
)

Arguments

repo_url	a URL for a remote repository and default to 'https://github.com/phuse-org/phuse-scripts.git'
repo_base	a URL for repository base folder; default to "https://github.com/phuse-org/phuse-scripts/raw/master"
repo_dir	a local directory to host the repository; default to work_dir from crt_workdir if not specified
work_dir	a local directory to host the files containing a list of YML files; default to tempdir()/myRepo
output_fn	a CSV file name for outputing a list of YML files; default to "repo_name_yml.csv
days_to_update	number of days before the output_fn is updated; default to 7 days. Set it to a negative number make it to update immediately.
fn_only	return file name only; default to FALSE
upd_opt	update option: File|Repo|Both

Value

a data frame containing a list of script metadata

Author(s)

Hanming Tu

Examples

## Not run: 
  r1 <- build_script_df()
  r2 <- build_script_df(upd_opt = "file")
  r3 <- build_script_df(upd_opt = "repo")
  r4 <- build_script_df(upd_opt = "both")

## End(Not run)

TuCai/phuse documentation built on Sept. 2, 2022, 5:17 a.m.