bradlindblad/cheatsheet

A simple package to grab cheat sheets and save them to your local computer

Brad Lindblad, MBA

Cloud

Languages

Other languages and tools

Connect with me

What I do

• I'm a Staff Analytics Engineer working at a software company called logos.com
• I write about data, etc. on technistema.com -- subscribe
• Certified R tidyverse trainer -- let me teach you
• Some popular open source projects:
  • Created algorithmic trading bot 📈
  • 📦 schrute R package creator, as well as versions for python and Julia
  • 📦 tidyUSDA R package creator 🐮; grabs USDA data in tidy format for analysis
  • 📦 cheatsheets R package creator; downloads all RStudio cheatsheets locally
  • 📦 proverbs R package creator; print out a daily Bible proverb to your console 📙
  • creator of one of the top apps in the Snapcraft.io store

Blog posts

• proverbs Now Has Support for ESV Translation
• Announcing proverbs; A Package For Printing a Daily Proverb in R
• Using Github Actions, Python and Telegram to Get Ribeye Specials
• Analyzing Roam Research Attribute Tables with Python
• Announcing the {cheatsheet} Package
• tidyUSDA Version 0.3.1 Is Now Available
• Professional Financial Reports with RMarkdown
• Introducing Schrute.jl: The Office Transcripts Data Set for Julia
• My First Linux Snapcraft App
• Using the Biblepi Program

My stats

cheatsheet's Issues

Release cheatsheet 0.1.1

Prepare for release:

• git pull
• Check current CRAN check results
• Polish NEWS
• devtools::build_readme()
• urlchecker::url_check()
• devtools::check(remote = TRUE, manual = TRUE)
• devtools::check_win_devel()
• rhub::check_for_cran()
• revdepcheck::cloud_check()
• Update cran-comments.md
• git push

Submit to CRAN:

• usethis::use_version('patch')
• devtools::submit_cran()
• Approve email

Wait for CRAN...

• Accepted 🎉
• git push
• usethis::use_github_release()
• usethis::use_dev_version()
• git push

Generate a Data Frame with Cheat Sheet Metadata

It would be nice if a function were created in the cheatsheet R package that captured metadata from the cheat sheet pdf files. The output would be either in the form of a tibble or a data frame. Information such as the package name, a summary description, the number of cheat sheet pages, and the version number and date, if applicable, that the cheat sheet was released.

This kind of metadata object would facilitate the determination needed to identify whether or not a package cheat sheet would need to be updated. Currently, there is no easy way to approach this task without manually opening a file to view the information.

Release cheatsheet 0.1.0

Prepare for release:

• Check that description is informative
• Check licensing of included files
• devtools::build_readme()
• usethis::use_cran_comments()
• devtools::check(remote = TRUE, manual = TRUE)
• devtools::check_win_devel()
• rhub::check_for_cran()
• Update cran-comments.md
• Review pkgdown reference index for, e.g., missing topics
• Draft blog post

Submit to CRAN:

• usethis::use_version('minor')
• devtools::submit_cran()
• Approve email

Wait for CRAN...

• Accepted 🎉
• usethis::use_news_md()
• usethis::use_github_release()
• usethis::use_dev_version()
• Update install instructions in README
• Finish blog post
• Post linkedin
• Add to favorites on github profile page
• Add link to blog post in pkgdown news menu

Missing R Cheat Sheets

There is an R cheat sheet that I have identified that should be added to the cheatsheet package. It is identified as follows:

xts - https://s3.amazonaws.com/assets.datacamp.com/blog_assets/xts_Cheat_Sheet_R.pdf

It is my hope that you will add this R cheat sheet to the cheatsheet package.

Naming Convention Recommendation for R cheatsheets

A review was conducted of all (73) of the files generated by applying the following code:

get_all_cheatsheets(local_path = "cheats", tidyverse_only = FALSE)

It was discovered that there are inconsistencies in the file-naming convention for these R cheat sheets. It would be nice if these file names were standardized largely based on the R package name principally represented by the cheat sheet.

In addition, there are two duplicate files that refer to the same R cheat sheet. These duplicate files should be removed. The duplicates are provided as follows:

• data-visualization.pdf and data-visualization-2.1.pdf
• rmarkdown.pdf and rmarkdown-2.0.pdf

File-naming conventions for these R cheat sheets are recommended as follows:

• Change base-r.pdf to base_Cheatsheet.pdf
• Change datatable.pdf to data.table._Cheatsheet.pdf
• Change time-series.pdf to timeSeries._Cheatsheet.pdf
• Change strings.pdf to stringr._Cheatsheet.pdf
• Change data-transformation.pdf to dplyr._Cheatsheet.pdf
• Change factors.pdf to forcats_Cheatsheet.pdf
• Change data-visualization.pdf to ggplot2_Cheatsheet.pdf
• Change data-import.pdf to tidyverse_Cheatsheet.pdf
• Change tidyeval.pdf to rlang_Cheatsheet.pdf
• Change parallel_computation.pdf to parallel_Cheatsheet.pdf

In addition, it is recommended that the suffix "_Cheatsheet.pdf" be added to the filename of each file in the cheatsheet category.