make_ggseg_repo: Initiate a ggseg atlas repo

In neuroconductor/ggsegExtra: Extra Utilities for the 'ggseg'-Plotting Tool

Description

This function will clone an existing ggseg atlas, and rename files and substitute strings in files to prepare a repository for ggseg atlas constribution.

Usage

make_ggseg_repo(
  atlas_name,
  package_name,
  directory = package_name,
  git_init = TRUE,
  remote_repo = NULL
)

Arguments

atlas_name	name for atlases, should be lower snake-case
package_name	package name in snake case
directory	directory to place the atlas in, defaults to package name
git_init	should git repo be initiated
remote_repo	a remote git repository to push to (must already exist)

Details

This process is not perfect, and you will need to go through files and make sure the information is correct, add data to the data-folder, alter atlas description in R-folder, make sure tests run in tests/testthat (comment out what is not necessary), etc.

At the end, a complete atlas ready for addition to ggsegExtra has noe errors and no warnings, but notes on data size are acceptable.

neuroconductor/ggsegExtra documentation built on Aug. 18, 2020, 4:45 p.m.