remove_table_forresdat: remove table(s) from data package 'forresdat'

View source: R/remove_table_forresdat.R

remove_table_forresdatR Documentation

remove table(s) from data package forresdat

Description

This function removes one or more tables from the data package forresdat by making a commit on a local clone of the git repository. While removing the table(s), it also updates the metadata (.json file)

Usage

remove_table_forresdat(tables, repo_path, push = FALSE, branch = "develop")

Arguments

tables

vector with table names of tables that should be removed

repo_path

name and path of local forresdat repository in which results/tables should be saved

push

push commits directly to the remote on GitHub? Default is FALSE (no). (This option can only be used with SSH.)

branch

branch from repository forresdat to which the new version should be committed. Default is 'develop'.

Value

No value is returned, the tables are removed from the git repository.

Examples

## Not run: 
#make a local clone of forresdat and change path before running
library(forrescalc)
# add path to your local clone of forresdat
path_to_forresdat <- "xxx/forresdat"
# if you don't have a local clone yet, make it:
git2r::clone("https://github.com/inbo/forresdat.git", path_to_forresdat)

remove_table_forresdat(
  tables = c("qCoverHerbs", "qtotalCover"),
  repo_path = path_to_forresdat
)

## End(Not run)


inbo/forrescalc documentation built on Sept. 28, 2024, 11:45 a.m.