Package 'jimstools'

Description

These simple aliases can be useful to avoid operator precedence ambiguity, or to make use of indents from commas within your text editor. The all-caps versions accept single-length (capable of 'short-circuits') logical conditions only.

Neithers and nors are identical except have slightly different short-circuits. NOR uses negation once so may be quicker if the first argument is very, very prompt.

Usage

AND(x, y)

OR(x, y)

nor(x, y)

neither(x, y)

NOR(x, y)

NEITHER(x, y)

pow()

XOR(x, y)

Arguments

Description

This function copies raw data from an external location (i.e. a mapped network drive) to a specified local project directory. In addition, a snapshot of the files being copied is taken and stored in the specified "cache_dir" so that files are only re-copied if changed.

Usage

backup_raw(from_dir, to_dir, cache_dir = "cache", force = FALSE)

Arguments

Value

Invisible - this function is used for its side effects

Description

Create README badges via img.shields.io

Usage

badge(label, value, color, url)

Arguments

Value

character string to be pasted into README

Description

Open fontawesome icons webpage

Usage

browse_fontawesome()

Description

Quick caching utility read/write functions utilizing the qs package.

Usage

write_cache(x, name = NULL, cache_dir = "cache", overwrite = TRUE)

read_cache(x, name = NULL, cache_dir = "cache")

Arguments

Value

invisibly returns object passed to the function.

x

invisibly attaches object to parent global environment

See Also

qs::qread() and qs::qsave()

Examples

## Not run: 
mydata <- mtcars
write_cache(mydata) # will save to 'cache/mydata'.
write_cache(mydata, "mydata-v2", cache_dir = "data/temp") # will save to 'data/temp/mydata-v2'

# read back in
read_cache(mydata)

## End(Not run)

Description

Coalesce Join

Usage

coalesce_join(
  x,
  y,
  by = NULL,
  suffix = c(".x", ".y"),
  join = dplyr::full_join,
  ...
)

Arguments

Value

joined data.frame with values replaced

Description

for each group, sets the top row of the group to the group's value. All other rows in the group are set to "". See the example

Usage

collapseRows(df, variable)

Arguments

Value

a data frame with an updated variable column

Description

Compares data across evaluations.

Usage

compare_to_prior(data, col)

Arguments

Value

new data frame with added columns for changes and priors

Description

Create Project

Usage

create_project(
  path,
  rstudio = rstudioapi::isAvailable(),
  open = rlang::is_interactive(),
  fields = list()
)

Arguments

Value

RStudio project (side-effect)

Description

Create RStudio Project

Usage

create_rstudio_project(name, path = ".", ...)

Arguments

Value

same as usethis::create_package().

Description

Vector of character strings from list of unquoted names

Usage

cs(...)

Arguments

Examples

cs(a,cat,dog)

Description

Because I always forget.

Usage

date_formats()

Description

Creates different vectors of related colors that may be useful for figures.

Usage

default_colors()

Value

Vector of character strings representing colors, in RGB.

Examples

plot(1:4,rep(1,4),col=default_colors(),pch=19,cex=5)
plot(1:16,rep(1,16),col=default_colors(),pch=19,cex=5)

Description

Prints the standard fframework for documenting a data frame in an R package.

Usage

document_df(df, num_spaces = 4)

Arguments

Value

nothing

Examples

set.seed(0)
dat <- data.frame(x = c(LETTERS[1:5]),
                  y = c(sample(1:100, 5)))
document_df(dat)

Description

Download button without opening up new window in browser when downloaded.

Usage

download_bttn(outputId, label = "Download", class = NULL, icon = NULL, ...)

Arguments

Value

download button HTML

Description

quickly edit .Renviron

Usage

editenv()

Description

Quickly edit .Rprofile

Usage

editprof()

Description

Create a Skeleton 'Grid' for Data based on combinations of unique column values

Usage

expand_from_vars(data, vars)

Arguments

Value

expanded data.frame

Description

If a string has more than one match, this will only return the first one.

Usage

extract_after(full_string, after_string, trim_spaces = TRUE)

Arguments

Value

A string

Examples

extract_after("What does the fox say?", after_string = "What does the")

Description

If a string has more than one match, this will only return the first one.

Usage

extract_before(full_string, before_string, trim_spaces = TRUE)

Arguments

Value

A string

Examples

extract_before("What does the fox say?", before_string = "say")

Description

If a string has more than one match, this will only return the first one.

Usage

extract_between(full_string, after_string, before_string, trim_spaces = TRUE)

Arguments

Value

A string

Examples

extract_between("What does the fox say?", after_string = "What does the", before_string = "say")

Description

Extracts dates from a character string with format "mm-dd-yyyy" or "mm/dd/yyyy".

Usage

extract_date(string)

Arguments

Value

date object

Examples

extract_date("data-raw/lossrun-as-of-2019-01-31.xlsx")

Description

Extract numbers from a string

Usage

extract_num(string)

Arguments

Value

String of numbers

Description

A set of helper functions for providing verbose feedback to the developer using this packages functions.

This function allows a package developer to automatically add these functions to their package.

Usage

use_feedback_helpers(pkg = ".")

msg_field(x)

msg_value(x)

msg_done(x)

msg_bullet(x, bullet = cli::symbol$bullet)

msg_err(x)

msg_path(x)

msg_info(x)

msg_code(x)

msg_feedback(x)

Arguments

See Also

• usethis::ui-questions()

• cli::list_symbols()

Other Feedback Utilities: indent(), inform()

Description

Determine the operating system (OS) of your machine.

Usage

get_os()

is_32bit_os()

is_64bit_os()

Value

OS name in lower case: windows, mac, linux, etc.

See Also

https://www.r-bloggers.com/identifying-the-os-from-r/

Examples

get_os()

Description

Pulls projects list from RStudio's AppData files.

Usage

get_rstudio_projects(exclude_nonexistant = TRUE)

Arguments

Value

data.frame

Description

Group loss data by occurrence ID.

Usage

group_by_occurrence(dat)

Arguments

Value

data grouped by occurrence

Examples

## Not run: 
dat <- readRDS("data/shiny-data.rds") %>%
  filter(
    eval_dt == as.Date("2018-12-31"),
    member == "Ace Endico Corporation"
  )
test <- by_occurrence(dat)

## End(Not run)

Description

The characters c("&", '"', "'", "<", ">") will be replaced with c("&", """, "'", "<", ">"), respectively.

Usage

htmlspecialchars(string)

Arguments

Value

the string with special chars replaced.

References

https://www.php.net/manual/en/function.htmlspecialchars.php

See Also

gsub

Examples

htmlspecialchars("<a href = 'https://yihui.org'>Yihui</a>")
# &lt;a href = &#039;https://yihui.org&#039;&gt;Yihui&lt;/a&gt;

Description

Determine if user is in an RStudio Environment

Usage

in_rstudio()

Value

logical

Description

Indentation around various msg_ feedback functions.

Usage

indent(x, first = "  ", indent = first)

Arguments

Value

string

See Also

Other Feedback Utilities: feedback, inform()

Description

A wrapper around rlang::inform() for providing feedback to developers using this packages functions.

Usage

inform(...)

Arguments

Value

feedback in console

See Also

rlang::inform()

Other Feedback Utilities: feedback, indent()

Description

Check if a package is installed.

Usage

is_inst(pkg)

Arguments

Details

This function provides a lightweight alternative to utils::installed.packages() by using nzchar instead.

Value

logical (TRUE/FALSE)

References

• Check for installed packages before running install.packages-Stack Overflow

Examples

## Not run: 
is_inst("dplyr")

## End(Not run)

Description

Ensures a text string is a valid email address

Usage

is_valid_email(x)

Arguments

Value

logical

Description

Call this function as an addin to launch a new project-less RStudio session without closing your currently open RStudio project(s).

Usage

launch_rstudio()

Description

Filter across multiple variables.

Usage

multi_filt(data, vars, filts)

Arguments

Details

NOTE: this function currently only supports character and factor level filtering by using the ⁠dplyr::filter(<var> %in% c(<filts>))⁠ syntax. For numeric and date level filtering will need to incorporate expressions like ⁠<= 5⁠ as filt arguments.

Value

a filtered data.frame or tibble.

References

dplyr::filter() rlang tidyeval tidyeval glue syntax

Examples

library(dplyr)
data <- datasets::iris
str(data)

iris_filtered <- multi_filt(data, vars = list("Species"), filts = list(c("setosa", "versicolor")))

str(iris_filtered) # filtered for only Species %in% c("setosa" and "versicolor")

Description

Open local version of pkgdown site for jimstools

Usage

open_docs()

Description

Open Github Repository URL

Usage

open_gh_repo()

Description

Function tries opening a file in RStudio.

Usage

open_in_rstudio(path, ...)

Arguments

See Also

• rstudioapi::navigateToFile(),

• fs::file_show(), browseURL(),

• utils::file.edit()

Description

Open pkgdown site of the package

Usage

open_pkgdown()

Description

Open RStudio Project

Usage

open_project()

Value

invisibly returns an RStudio project

Description

Extensions of base operators.

inverse of %in%

Usage

x %notin% vector

x %allin% vector

x %anyin% vector

x %nonein% vector

pattern %partin% vector

Arguments

Value

logical

logical

See Also

base::any(), base::match(), and base::all()

base::grepl()

Examples

data <- data.frame(
  id = 1:10,
  x = as.integer(runif(10, 0, 10))
)

data[data$id %notin% c(1, 3, 5, 7, 9), ]

1:2 %allin% 1:3  # TRUE
3:4 %allin% 1:3  # FALSE
3:4 %anyin% 1:3  # TRUE
4:5 %anyin% 1:3  # FALSE
3:4 %nonein% 1:3  # FALSE
4:5 %nonein% 1:3  # TRUE
"Bei" %partin% c("Beijing", "Shanghai")  # TRUE
"bei" %partin% c("Beijing", "Shanghai")  # FALSE
"[aeiou]ng" %partin% c("Beijing", "Shanghai")  # TRUE

Description

Paste Winslash - Addin Function

Usage

paste_winslash()

Details

assign to keyboard shortcut Ctrl + Shift + P for easy access.

Value

normalized path character string

Description

Print the current date in a pretty format

Usage

print_date()

Value

string

Examples

print_date()

Description

Pull all unique values for a variable

Usage

pull_unique(data, var, sort = TRUE, decreasing = FALSE, names = TRUE)

Arguments

Value

vector

htable Create a quick html table using my favorites options for DT::datatable()

Description

htable Create a quick html table using my favorites options for DT::datatable()

Usage

quick_table(df, ...)

Arguments

Examples

quick_table(mtcars)

Description

This function generates a random passord sampled from the ASCII table.

Usage

random_password(length = 12, replace = FALSE, extended = TRUE)

Arguments

Value

a character string

See Also

sample

Examples

random_password()
# set the seed to get fixed password every time; you may just remember the
# seed and forget the real password because it's reproducible
set.seed(123)
random_password()
# long password
random_password(20, TRUE)

Description

Renders a template using whisker::whisker.render() for templates used in a fashion similar to usethis::use_template().

Usage

render_template(template_path, out_path, data = list(), open = TRUE)

Arguments

Value

invisible

Description

Copies the graphics contents of current device to PDF (a wrapper for dev2.pdf). Default size is 8.5 x 11 in landscape mode.

Usage

save_pdf(file, width = 11, height = 8.5, jpg = FALSE)

Arguments

Description

Use these functions to search the web directly from your browser, building advanced queries and supplying common useful R related domains.

Query Github's internal search engine.

Query a search on rseek.org.

Query a search on the R Nabble Forum. Nabble is an innovative search engine for R messages.

Usage

search_online(s, query_url = "https://google.com/search?q=")

search_gh(
  s,
  type = "all",
  language = NULL,
  topic = NULL,
  user = NULL,
  org = NULL
)

search_rseek(s)

search_finzi(s)

search_nabble(s)

search_google(s)

search_rproject(s)

search_metacran(s)

Arguments

Details

See https://cloud.r-project.org/search.html which showcases Google's advanced search feature to query only R-Project domain sites via the Google Search Engine.

Functions

• search_gh():

• search_rseek():

• search_finzi():

• search_nabble():

• search_google():

• search_rproject():

• search_metacran():

References

• http://www.sashagoodman.com/

• http://finzi.psych.upenn.edu/search.html

• http://finzi.psych.upenn.edu/search/manual.html#query

• https://cloud.r-project.org/search.html

• http://n4.nabble.com/help/Answer.jtp?id=31

Examples

# default search on google
search_online("polished.tech")

# search github (note: &ref=opensearch)
search_online("polished", "https://github.com/search?q=%s&ref=opensearch")

# search Github with language:r, org:tychobra for 'polished' (note: '%3A' represents a ':')
search_online("polished", "https://github.com/search?q=%s+language%3Ar+org%3Atychobra")
search_gh("websocket", language = "r", topic = "rshiny")

# search your org
search_gh("polished", org = "tychobra")

Description

Set working directory to the path of current script

Usage

set_wd(dir = NULL)

Arguments

See Also

setwd

Examples

## Not run: 
set_wd()  # set working directory to the path of the current R script

set_wd("D:/")  # "\" is not allowed, you should use "/"

set_wd("../")  # set working directory to the parent directory

## End(Not run)

Description

Shiny Icons

Usage

shiny_icons()

Value

character vector of shiny package icons

Description

There is a command shutdown in both Windows and Linux, and this function uses it to shut down a computer.

Usage

shutdown(wait = 0)

Arguments

Details

After the time wait has passed, R will execute shutdown -s -t 0 (for Windows) or shutdown -h now to shut down the computer.

Value

The status code of system.

See Also

system, Sys.sleep

Examples

if (interactive()) {
# when your code is extremely time-consuming, you may need this function;
# e.g. you go to sleep, and R is running long computation...
# complex graphics... and long long computation... at last,
shutdown()
# the next day you wake up, "thank you, R" :)
}

Description

Use these utility functions to quickly edit your .Rprofile, .Renviron, or other startup files.

Usage

editrprof(scope = c("user", "project"))

editrenv(scope = c("user", "project"))

Arguments

Value

invisible

See Also

See base::Startup() for details on the R specific startup process.

Description

This function creates a .gitattributes file in the root of your project in order to exclude certain file types from being detected as a certain programming language on GitHub. See details for more information.

Usage

use_gh_linguist(excludes = c("*.js", "*.html", "*.css"))

Arguments

Details

By default this function will write ⁠*.js⁠, ⁠*.html⁠, and ⁠*.css⁠ to a .gitattributes file in order for github-linguist to ignore Javascript, HTML, and CSS languages in your repositories language section.

The resulting file will look like so:

# github linguist exclusions:
*.js linguist-vendored
*.html linguist-vendored
*.css linguist-vendored

Value

invisibly returns the text written to .gitattributes

Examples

## Not run: 
use_gh_linguist()

## End(Not run)

Description

Get user-related information.

Usage

user_info()

Value

invisibly returns os_info vector

Examples

user_info()

Description

Interactive view of list structures with listviewer::jsonedit()

Usage

view_list(list, ...)

Arguments

Examples

view_list(mtcars)