Installation

# from cran (soon!)
install.packages('PkgsFromFiles')

# from github
if (!require(devtools)) install.packages('devtools')
devtools::install_github('msperlin/PkgsFromFiles')

Usage

The main function of the package is pff_find_and_install_pkgs, which will search and install missing packages from R files at a given directory. As an example, we’ll use my research folder from Dropbox. It contains all R scripts I have ever used in my research work. Let’s try it out:

# Evaluation is disable so it passes CRAN CHECKS, but you should be able to run it in your computer
library(PkgsFromFiles)

# target folder
my.dir <- '~/Dropbox/01-Pesquisa/'

df <- pff_find_and_install_pkgs(folder.in = my.dir)

## 
## Searching folder  ~/Dropbox/01-Pesquisa/
##  Found 74 files in 18 folders
##       R Scripts: 72 files
##       Rmarkdown files: 2 files
##       Sweave files: 0 files

## Warning: `data_frame()` is deprecated as of tibble 1.1.0.
## Please use `tibble()` instead.
## This warning is displayed once every 8 hours.
## Call `lifecycle::last_warnings()` to see where this warning was generated.

## 
## Checking available pkgs from https://cloud.r-project.org
## Checking and installing missing pkgs
## Installing rvest Already installed
## Installing tidyverse Already installed
## Installing furrr Already installed
## Installing XML   Already installed
## Installing fst   Already installed
## Installing stringr   Already installed
## Installing lubridate Already installed
## Installing ggplot2   Already installed
## Installing GetDFPData    Already installed
## Installing genderBR  Already installed
## Installing purrr Already installed
## Installing xlsx  Already installed
## Installing sandwich  Already installed
## Installing stargazer Already installed
## Installing Hmisc Already installed
## Installing plm   Already installed
## Installing lmtest    Already installed
## Installing MatchIt   Already installed
## Installing devtools  Already installed
## Installing RSelenium Already installed
## Installing GetLattesData Already installed
## Installing xtable    Already installed
## Installing httr  Already installed
## Installing parallel  Installation failed, pkg not in CRAN
## Installing BatchGetSymbols   Already installed
## Installing readxl    Already installed
## Installing RSQLite   Already installed
## Installing pbapply   Already installed
## Installing ggmap Already installed
## Installing memoise   Already installed
## Installing gganimate Already installed
## Installing texreg    Already installed
## Installing pglm  Already installed
## Installing estimatr  Already installed
## Installing AER   Already installed
## Installing quantreg  Already installed
## Installing nnet  Already installed
## Installing simfinR   Already installed
## Installing fGarch    Already installed
## Installing MTS   Already installed
## Installing DescTools Already installed
## 
## Summary:
##  Found 40 packages already installed
##  Had to install 0 packages
##  Installation failed for 1 packages
##      1 due to package not being found in CRAN
##      0 due to missing dependencies or other problems
## 
## Check output dataframe for more details about failed packages

As you can see, function pff_find_and_install_pkgs will find all R related files recursively in the given folder. In this case, I have all packages locally so no installation was required. A summary in text is shown at the end of execution.

The output of the function is a dataframe with the details of the operation. Have a look:

dplyr::glimpse(df)

## Rows: 41
## Columns: 3
## $ pkg            <chr> "rvest", "tidyverse", "furrr", "XML", "fst", "stringr"…
## $ status.message <chr> "Already installed", "Already installed", "Already ins…
## $ installation   <lgl> TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, …

The package also includes function pff_find_R_files_from_folder, which will find all packages used in R related files from a given folder. It outputs a dataframe with several information about packages used in the found scripts.

df.files <- pff_find_R_files_from_folder(folder.in = my.dir)

## 
## Searching folder  ~/Dropbox/01-Pesquisa/
##  Found 74 files in 18 folders
##       R Scripts: 72 files
##       Rmarkdown files: 2 files
##       Sweave files: 0 files

dplyr::glimpse(df.files)

## Rows: 74
## Columns: 5
## $ files      <chr> "/home/msperlin/Dropbox/01-Pesquisa//01-Working Papers/01-…
## $ file.names <chr> "01-01_S-unzip_affiliation_tables.R", "01-02_S-read_affili…
## $ extensions <chr> "R", "R", "R", "R", "R", "R", "R", "R", "R", "R", "R", "R"…
## $ pkgs       <chr> "rvest ; tidyverse ; furrr ; XML", "tidyverse ; furrr ; fs…
## $ n.pkgs     <int> 4, 3, 8, 6, 6, 6, 8, 8, 8, 1, 1, 8, 8, 8, 4, 1, 7, 9, 4, 8…

I also wrote a simple function for plotting the most used packages for a given folder:

# target folder
my.dir <- '~/Dropbox/01-Pesquisa/'

# plot most used pkgs
p <- pff_plot_summary_pkgs(folder.in = my.dir)

## 
## Searching folder  ~/Dropbox/01-Pesquisa/
##  Found 74 files in 18 folders
##       R Scripts: 72 files
##       Rmarkdown files: 2 files
##       Sweave files: 0 files

print(p)

As you can see, I’m a big fan of the tidyverse!

Hope you guys find the package useful! Fell free to send any question to the comment section of the post or my email (marceloperlin@gmail.com).