Package 'gagglr'

Title: Corralling Our Gaggle of OHA R Utility Packages
Description: Since package are developed with a regular update cycle, users can often be using outdated packages that resolve bug or add new features. This checks to ensure you are using the lastest version of the OHA core package and allows you to load them all at the start of a session. This package borrows heavily from the tidyverse package.
Authors: Aaron Chafetz [aut, cre], Baboyma Kagniniwa [aut]
Maintainer: Aaron Chafetz <[email protected]>
License: MIT + file LICENSE
Version: 0.2.2
Built: 2024-11-19 06:28:29 UTC
Source: https://github.com/USAID-OHA-SI/gagglr

Help Index


Check for OHA package updates

Description

This function compares the local version of the package against what is stored on GitHub to flag whether or not you have the latest version.

Usage

oha_check(
  name,
  url = "https://github.com/USAID-OHA-SI",
  suppress_success = FALSE
)

Arguments

name

package name

url

user/organization url, default = "https://github.com/USAID-OHA-SI"

suppress_success

suppress message if up to date, default = FALSE

Value

message if there is a newer package on GH than local

Examples

oha_check("gophr")
oha_check("glamr")

List all OHA Packages

Description

List all OHA Packages

Usage

oha_packages(include_self = TRUE)

Arguments

include_self

Include gagglr in the list?

Examples

oha_packages()

Get a situation report on OHA packages

Description

This function gives a quick overview of the versions of R and RStudio as well as all OHA packages. It's primarily designed to help you get a quick idea of what's going on when you're helping someone else debug a problem.

Usage

oha_sitrep()

Update OHA packages

Description

This will check to see if all your OHA packages are up-to-date, and will install after an interactive confirmation. The versions may match between GitHub and your local environment, but may still be behind on recent commits that do not merit a full version update.

Usage

oha_update(install = FALSE, core_only = FALSE)

Arguments

install

do you want to install or just print the status, default = FALSE

core_only

only check/install core OHA package? default = FALSE

Examples

## Not run: 
#list of what packages are out of date/non installed w/ code to install
oha_update()

#interactively install core packages
oha_update(install = TRUE, core_only = TRUE)

#automatically install all OHA packages
oha_update(install = TRUE)

## End(Not run)