detach all packages while working in R
Asked Answered
H

11

132

While working to solve another problem I got this problem:

I can remove all R objects by:

rm(list = ls(all = TRUE))

Is there equivalent command that can detach installed packages during working session?

> sessionInfo()
R version 2.12.2 (2011-02-25)
Platform: i386-pc-mingw32/i386 (32-bit)

locale:
[1] LC_COLLATE=English_United States.1252 
[2] LC_CTYPE=English_United States.1252   
[3] LC_MONETARY=English_United States.1252
[4] LC_NUMERIC=C                          
[5] LC_TIME=English_United States.1252    

attached base packages:
[1] stats     graphics  grDevices utils     datasets  methods   base 

require(ggplot2)

Loading required package: ggplot2
Loading required package: reshape
Loading required package: plyr

Attaching package: 'reshape'

The following object(s) are masked from 'package:plyr':

    round_any

Loading required package: grid
Loading required package: proto

sessionInfo()

R version 2.12.2 (2011-02-25)
Platform: i386-pc-mingw32/i386 (32-bit)

locale:
[1] LC_COLLATE=English_United States.1252 
[2] LC_CTYPE=English_United States.1252   
[3] LC_MONETARY=English_United States.1252
[4] LC_NUMERIC=C                          
[5] LC_TIME=English_United States.1252    

attached base packages:
[1] grid      stats     graphics  grDevices utils     datasets  methods  
[8] base     

other attached packages:
[1] ggplot2_0.8.9 proto_0.3-9.1 reshape_0.8.4 plyr_1.4 

I tried this way, although even it worked in not a global solution :

pkg <- c("package:ggplot2_0.8.9", "package:proto_0.3-9.1", "package:reshape_0.8.4",  "package:plyr_1.4")

 detach(pkg, character.only = TRUE)

Error in detach(pkg, character.only = TRUE) : invalid 'name' argument
In addition: Warning message:
In if (is.na(pos)) stop("invalid 'name' argument") :
  the condition has length > 1 and only the first element will be used

What I am loking for is something global like:

  rm(list = ls(all = TRUE))

for objects, expect it would not remove attached base packages

thanks;

Howarth answered 21/9, 2011 at 19:31 Comment(4)
Not that your question isn't valid, but why not just restart R?Engle
@Aaron because you shouldn't have too ;-) To pass R CMD check a package is supposed to cleanly unload itself, so R Core expect this to be possible and something one might wish to do.Rumsey
@Aaron, I think sometime it might be useful to let session going when some packages are causing or might cause interference, but were used in previous steps ...Howarth
It's not possible to return R to a fresh slate. I've talked with John Chambers about this, and it's particularly difficult to do for S4 class/method registration.Headfirst
Y
131

So, someone should have simply answered the following.

lapply(paste('package:',names(sessionInfo()$otherPkgs),sep=""),detach,character.only=TRUE,unload=TRUE)

(edit: 6-28-19) In the latest version of R 3.6.0 please use instead.

invisible(lapply(paste0('package:', names(sessionInfo()$otherPkgs)), detach, character.only=TRUE, unload=TRUE))

Note the use of invisible(*) is not necessary but can be useful to prevent the NULL reply from vertically spamming the R window.

(edit: 9/20/2019) In version 3.6.1

It may be helpful to convert loaded only names(sessionInfo()$loadedOnly) to explicitly attached packages first, and then detach the packages, as so.

lapply(names(sessionInfo()$loadedOnly), require, character.only = TRUE)
invisible(lapply(paste0('package:', names(sessionInfo()$otherPkgs)), detach, character.only=TRUE, unload=TRUE, force=TRUE))

One can attempt to unload base packages via $basePkgs and also attempt using unloadNamespace(loadedNamespaces()). However these typically are fraught with errors and could break basic functionality such as causing sessionInfo() to return only errors. This typically occurs because of a lack of reversibility in the original package's design. Currently timeDate can break irreversibly, for example.

(edit: 9/24/20) for version 4.0.2 The following first loads packages to test and then gives a sequence to fully detach all packages except for package "base" and "utils". It is highly recommended that one does not detach those packages.

    invisible(suppressMessages(suppressWarnings(lapply(c("gsl","fBasics","stringr","stringi","Rmpfr"), require, character.only = TRUE))))
    invisible(suppressMessages(suppressWarnings(lapply(names(sessionInfo()$loadedOnly), require, character.only = TRUE))))
    sessionInfo()

    #the above is a test

    invisible(lapply(paste0('package:', c("stringr","fBasics")), detach, character.only=TRUE,unload=TRUE))
    #In the line above, I have inserted by hand what I know the package dependencies to be. A user must know this a priori or have their own automated
    #method to discover it. Without removing dependencies first, the user will have to cycle through loading namespaces and then detaching otherPkgs a
    #second time through.
    invisible(lapply(paste0('package:', names(sessionInfo()$otherPkgs)), detach, character.only=TRUE,unload=TRUE))

    bspkgs.nb<-sessionInfo()$basePkgs[sessionInfo()$basePkgs!="base"]
    bspkgs.nbu<-bspkgs.nb[bspkgs.nb!="utils"]
    names(bspkgs.nbu)<-bspkgs.nbu
    suppressMessages(invisible(lapply(paste0('package:', names(bspkgs.nbu)), detach, character.only=TRUE,unload=TRUE)))

    #again this thoroughly removes all packages and loaded namespaces except for base packages "base" and "utils" (which is highly not recommended).
Yonder answered 30/8, 2016 at 18:53 Comment(8)
I think this deserves upvotes because of its simplicity and does not need additional packages.Spanker
This did not work for me. I ran it got warnings, then ran session.info() all packages were still there.Localism
Yes in the latest version of R 3.6.0 one should use the following instead. invisible(lapply(paste0('package:', names(sessionInfo()$otherPkgs)), detach, character.only=TRUE, unload=TRUE)) Note the use of invisible(*) is not required but can prevent the NULL reply from vertically spamming the window.Yonder
Using invisible(lapply(paste0('package:', names(sessionInfo()$otherPkgs)), detach, character.only=TRUE, unload=TRUE)) results in an Error in FUN(X[[i]], ...) : invalid 'name' argument errorSuttee
The error Error in FUN(X[[i]], ...)... frequently occurs when there is only a NULL value present. One can test for this with names(sessionInfo()$otherPkgs). If it returns NULL, then this is the cause.Yonder
It should work now and detach even more packages. The issue seemed to be the weird protection added to sessionInfo()$basePkgs Even though this tests correct with all expected attributes, typeof's, classes, and object type, it seems to be highly protected and refuses to be parsed normally. Additionally, it seems the function of the operation names has been changed significantly, and is much more restrictive inexplicably.Yonder
@mmfrgmpds, This is not working at all with R version 4.1.0 (2021-05-18).Impersonate
@Krantz, This seems to be an anomalous behavior in 4.1.0. I have confirmed that the functionality has returned in version 4.2.1 and version 4.2.2 (current version of R).Yonder
W
64

Please try this:

detachAllPackages <- function() {

  basic.packages <- c("package:stats","package:graphics","package:grDevices","package:utils","package:datasets","package:methods","package:base")

  package.list <- search()[ifelse(unlist(gregexpr("package:",search()))==1,TRUE,FALSE)]

  package.list <- setdiff(package.list,basic.packages)

  if (length(package.list)>0)  for (package in package.list) detach(package, character.only=TRUE)

}

detachAllPackages()
Wholly answered 11/1, 2012 at 10:12 Comment(2)
in case when you messed up plyr & dplyr it seems the only way to go. Thanks!Bonny
This works for R 4.0.2, whereas other solutions appear not toHarman
F
31

nothing

It may be worth to add solution made available by Romain François. When loaded the package nothing, which is currently available on GitHub, will unload all of the loaded packages; as in the example that Romain provides:

loadedNamespaces()
[1] "base"      "datasets"  "grDevices" "graphics"  "methods"   "stats"
[7] "utils"

require(nothing, quietly = TRUE)

loadedNamespaces()
[1] "base"

Installation

With use of the devtools package:

devtools::install_github("romainfrancois/nothing")

pacman

An alternative approach uses pacman package available through CRAN:

pacman::p_unload(pacman::p_loaded(), character.only = TRUE)
Fox answered 24/1, 2017 at 12:52 Comment(4)
Looking at the vignette (trinker.github.io/pacman/vignettes/Introduction_to_pacman.html) maybe pacman::p_unload("all") would work as well?Cothran
'nothing' could actually be a really useful little package, but it removes 'utils' and then crashes RStudio if you try to reload it.Foredate
@Foredate The OP didn't mention anything about working in RStudio, naturally if you happen to be working with R using RStudio, VSCode, Nvim-R or any other setup you may be willing to keep the required packages loaded. Other answers provide ways of achieving that. BTW, I reckon that RStudio may need some other packages to be loaded so it can function properly; like rstudioapi and whatever is required to support the add-ins mechanism.Fox
pacman did not work for me, but sure require(nothing, quietly = TRUE) worked! thanks.Guardhouse
R
29

You were close. Note what ?detach has to say about the first argument name of detach():

Arguments:

name: The object to detach.  Defaults to ‘search()[pos]’.  This can
      be an unquoted name or a character string but _not_ a
      character vector.  If a number is supplied this is taken as
      ‘pos’.

So we need to repeatedly call detach() once per element of pkg. There are a couple of other arguments we need to specify to get this to work. The first is character.only = TRUE, which allows the function to assume that name is a character string - it won't work without it. Second, we also probably want to unload any associated namespace. This can be achieved by setting unload = TRUE. So the solution is, for example:

pkg <- c("package:vegan","package:permute")
lapply(pkg, detach, character.only = TRUE, unload = TRUE)

Here is a full example:

> require(vegan)
Loading required package: vegan
Loading required package: permute
This is vegan 2.0-0
> sessionInfo()
R version 2.13.1 Patched (2011-09-13 r57007)
Platform: x86_64-unknown-linux-gnu (64-bit)

locale:
 [1] LC_CTYPE=en_GB.utf8       LC_NUMERIC=C             
 [3] LC_TIME=en_GB.utf8        LC_COLLATE=en_GB.utf8    
 [5] LC_MONETARY=C             LC_MESSAGES=en_GB.utf8   
 [7] LC_PAPER=en_GB.utf8       LC_NAME=C                
 [9] LC_ADDRESS=C              LC_TELEPHONE=C           
[11] LC_MEASUREMENT=en_GB.utf8 LC_IDENTIFICATION=C      

attached base packages:
[1] stats     graphics  grDevices utils     datasets  methods  
[7] base     

other attached packages:
[1] vegan_2.0-0   permute_0.7-0

loaded via a namespace (and not attached):
[1] grid_2.13.1     lattice_0.19-33 tools_2.13.1   
> pkg <- c("package:vegan","package:permute")
> lapply(pkg, detach, character.only = TRUE, unload = TRUE)
[[1]]
NULL

[[2]]
NULL

> sessionInfo()
R version 2.13.1 Patched (2011-09-13 r57007)
Platform: x86_64-unknown-linux-gnu (64-bit)

locale:
 [1] LC_CTYPE=en_GB.utf8       LC_NUMERIC=C             
 [3] LC_TIME=en_GB.utf8        LC_COLLATE=en_GB.utf8    
 [5] LC_MONETARY=C             LC_MESSAGES=en_GB.utf8   
 [7] LC_PAPER=en_GB.utf8       LC_NAME=C                
 [9] LC_ADDRESS=C              LC_TELEPHONE=C           
[11] LC_MEASUREMENT=en_GB.utf8 LC_IDENTIFICATION=C      

attached base packages:
[1] stats     graphics  grDevices utils     datasets  methods  
[7] base     

loaded via a namespace (and not attached):
[1] grid_2.13.1     lattice_0.19-33 tools_2.13.1

If you want to turn this into a function, study the code in sessionInfo() to see how it identifies what it labels as "other attached packages:". Combine that bit of code with the idea above in a single function and you are home and dry. I'll leave that bit up to you though.

Rumsey answered 21/9, 2011 at 19:43 Comment(5)
you can automate this by adding pkgs = names(sessionInfo()$otherPkgs) and pkgs = paste('package:', pkgs, sep = "")Gastroenteritis
@Gastroenteritis +1 Indeed - but I didn't want to be too helpful ;-)Rumsey
You may also want to add force=TRUE in case the packages have dependencies.Indigotin
@James, where should force = T be added?Kopans
@Kopans it's an argument to detach()Rumsey
S
9

Building on Gavin's answer but not quite to a full function would be this sequence:

sess.pkgs <- function (package = NULL) 
{   z <- list()
       if (is.null(package)) {
        package <- grep("^package:", search(), value = TRUE)
        keep <- sapply(package, function(x) x == "package:base" || 
            !is.null(attr(as.environment(x), "path")))
        package <- sub("^package:", "", package[keep])
    }
    pkgDesc <- lapply(package, packageDescription)
    if (length(package) == 0) 
        stop("no valid packages were specified")
    basePkgs <- sapply(pkgDesc, function(x) !is.null(x$Priority) && 
        x$Priority == "base")
    z$basePkgs <- package[basePkgs]
    if (any(!basePkgs)) {
        z$otherPkgs <-  package[!basePkgs]
    }
    z
}

lapply(paste("package:",sess.pkgs()$otherPkgs, sep=""), detach, 
                             character.only = TRUE, unload = TRUE)
Smectic answered 21/9, 2011 at 20:20 Comment(1)
somehow I can do the same with a one-liner lapply(paste("package:", names(sessionInfo()$otherPkgs), sep=""), detach, character.only = TRUE, unload = TRUE). Would never get there without your answer though!Seen
A
4

or if you have RStudio, simply uncheck all the checked boxes in Packages Tab to detach

Angiosperm answered 5/6, 2017 at 7:51 Comment(1)
If you have a lot of loaded packages, it is cumbersome to uncheck every one manually.Delgado
E
3

Most of the times its the plyr vs dplyr issue. Use this in the beginning of the code:

detach("package:plyr", unload=TRUE)

So whenever the script runs, its clears the plyr package

Euplastic answered 24/12, 2017 at 1:45 Comment(0)
M
3
#Detach all  packages
detachAllPackages <- function() {

  basic.packages <- c("package:stats","package:graphics","package:grDevices","package:utils","package:datasets","package:methods","package:base")

  package.list <- search()[ifelse(unlist(gregexpr("package:",search()))==1,TRUE,FALSE)]

  package.list <- setdiff(package.list,basic.packages)

  if (length(package.list)>0)  for (package in package.list) detach(package, character.only=TRUE)

}

detachAllPackages()

this will make sure all packages gets detached apart from your basic packages

Mate answered 9/4, 2020 at 12:45 Comment(1)
How is this different from @Wholly answerSciurine
B
0

Combining bits from various answers gave the most robust solution I could find...

packs <- c(names(sessionInfo()$otherPkgs), names(sessionInfo()$loadedOnly))
if(length(packs) > 0){ 
  message('Unloading packages -- if any problems occur, please try this from a fresh R session')
  while(length(packs) > 0){
    newpacks <- c()
    for(packi in 1:length(packs)){
      u=try(unloadNamespace(packs[packi]))
      if(class(u) %in% 'try-error') newpacks <- c(newpacks,packs[packi])
    }
    packs <- newpacks
    Sys.sleep(.1)
  }
}
Beckibeckie answered 27/9, 2019 at 12:32 Comment(0)
S
0

Why not the below to remove all attached packages ?

intialPackages = search() # added as 1st line of R script to get list of default packages
# below lines are added when newly attached packages needs to be removed
newPackages = search()[!(search() %in% intialPackages)]
try(sapply(newPackages, detach, character.only=TRUE, unload=TRUE, force=TRUE), silent=TRUE)
Sunless answered 23/4, 2021 at 17:13 Comment(0)
B
-1

if you're having problems with packages that have similarly named functions conflicting with each other, you can always reference the namespace of the package who's function you DO want.

pkg_name::function_i_want()
Bugleweed answered 25/1, 2019 at 14:27 Comment(2)
This is comment instead of an answer to the asked question.Delgado
Suppose I ought have set this as comment to the previous plyr v. dplyr answer, is it possible to move it? I am still learning the conventions here.Bugleweed

© 2022 - 2024 — McMap. All rights reserved.