update_gallery: Update gallery

View source: R/z_pages.R

update_galleryR Documentation

Update gallery

Description

A gallery is a collection of meta-data about animints that have been published to github pages. A gallery is defined as a github repo that should have two source files in the gh-pages branch: repos.txt (list of github repositories, one owner/repo per line) and index.Rmd (source for web page with links to animints). To perform the update, first repos.txt is read, then we clone each repo which is not already present in meta.csv, and parse meta-data (title, source, Capture.PNG) from the gh-pages branch, and write the meta.csv/error.csv/Capture.PNG files, render index.Rmd to index.html, commit, and push origin. For an example, see the main gallery, https://github.com/animint/gallery/tree/gh-pages which is updated using this function.

Usage

update_gallery(gallery_path = "~/R/gallery")

Arguments

gallery_path

path to local github repo with gh-pages active.

Value

named list of data tables (meta and error).

Author(s)

Toby Dylan Hocking


animint2 documentation built on Nov. 22, 2023, 1:07 a.m.