diff --git a/DESCRIPTION b/DESCRIPTION index a3dafef3b..757776fb0 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -16,6 +16,7 @@ License: GPL-3 Encoding: UTF-8 LazyData: true ByteCompile: true +Roxygen: list(markdown = TRUE) RoxygenNote: 7.2.3.9000 Depends: R (>= 3.5) diff --git a/R/package.R b/R/package.R index a13a3bcf5..07e739c9b 100644 --- a/R/package.R +++ b/R/package.R @@ -5,12 +5,12 @@ #' package library. #' #' @param pkg Package names or package references. E.g. -#' - `ggplot2`: package from CRAN, Bioconductor or a CRAN-like repository +#' - `ggplot2` or `cran::ggplot2`: package from CRAN, Bioconductor or a CRAN-like repository #' in general, -#' - `tidyverse/ggplot2`: package from GitHub, -#' - `tidyverse/ggplot2@v3.4.0`: package from GitHub tag or branch, -#' - `https://examples.com/.../ggplot2_3.3.6.tar.gz`: package from URL, -#' - `.`: package in the current working directory. +#' - `tidyverse/ggplot2` or `github::tidyverse/ggplot2`: package from GitHub, +#' - `tidyverse/ggplot2@v3.4.0` or `github::tidyverse/ggplot2@v3.4.0`: package from GitHub tag or branch, +#' - `url::https://examples.com/.../ggplot2_3.3.6.tar.gz`: package from URL, +#' - `.` or `local::.`: package in the current working directory. #' #' See "[Package sources]" for more details. #' @param lib Package library to install the packages to. Note that _all_ diff --git a/man/cache.Rd b/man/cache.Rd index 19a17499e..1c0468f3b 100644 --- a/man/cache.Rd +++ b/man/cache.Rd @@ -53,78 +53,19 @@ packages in the package cache. \section{Examples}{ -\if{html}{\out{
}}\preformatted{cache_summary() -}\if{html}{\out{
}}\if{html}{\out{ -
-#> $cachepath                                                              
-#> [1] "/Users/gaborcsardi/Library/Caches/org.R-project.R/R/pkgcache/pkg"  
-#>                                                                         
-#> $files                                                                  
-#> [1] 483                                                                 
-#>                                                                         
-#> $size                                                                   
-#> [1] 654662486                                                           
-#>                                                                         
-
-}} - - - -\if{html}{\out{
}}\preformatted{cache_list() -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 483 × 11                                                
-#>    fullpath       path  package url   etag  sha256 version platf…¹ built
-#>    <chr>          <chr> <chr>   <chr> <chr> <chr>  <chr>   <chr>   <int>
-#>  1 /Users/gaborc… arch… NA      http… "\\"1… 0c8f0… NA      NA         NA
-#>  2 /Users/gaborc… bin/… evalua… http… "\\"1… 08a39… 0.17    aarch6…    NA
-#>  3 /Users/gaborc… bin/… crayon  http… "\\"2… 1e6d5… 1.5.2   aarch6…    NA
-#>  4 /Users/gaborc… bin/… common… http… "\\"4… 47b4a… 1.8.1   aarch6…    NA
-#>  5 /Users/gaborc… bin/… curl    http… "\\"b… 7b8ba… 4.3.3   aarch6…    NA
-#>  6 /Users/gaborc… bin/… tinytex http… "\\"2… 7e9ba… 0.42    aarch6…    NA
-#>  7 /Users/gaborc… bin/… jsonli… http… "\\"1… 68e59… 1.8.2   aarch6…    NA
-#>  8 /Users/gaborc… bin/… lifecy… http… "\\"1… 7ce27… 1.0.3   aarch6…    NA
-#>  9 /Users/gaborc… bin/… vctrs   http… "\\"1… c3a69… 0.4.2   aarch6…    NA
-#> 10 /Users/gaborc… src/… pkgcac… NA     NA   9b70a… NA      NA          0
-#> # … with 473 more rows, 2 more variables: vignettes <int>,              
-#> #   rversion <chr>, and abbreviated variable name ¹​platform            
-
-}} - - -\if{html}{\out{
}}\preformatted{cache_list(package = "recipes") -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 1 × 11                                                  
-#>   fullp…¹ path  package url   etag  sha256 version platf…² built vigne…³
-#>   <chr>   <chr> <chr>   <chr> <chr> <chr>  <chr>   <chr>   <int>   <int>
-#> 1 /Users… bin/… recipes http… "\\"1… e281e… 1.0.2   aarch6…    NA      NA
-#> # … with 1 more variable: rversion <chr>, and abbreviated variable      
-#> #   names ¹​fullpath, ²​platform, ³​vignettes                           
-
-}} - - -\if{html}{\out{
}}\preformatted{cache_list(platform = "source") -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 69 × 11                                                 
-#>    fullpath       path  package url   etag  sha256 version platf…¹ built
-#>    <chr>          <chr> <chr>   <chr> <chr> <chr>  <chr>   <chr>   <int>
-#>  1 /Users/gaborc… src/… crayon  http… "\\"9… 70a9a… 1.5.2   source     NA
-#>  2 /Users/gaborc… src/… zip     http… "\\"1… 14873… 2.2.1   source     NA
-#>  3 /Users/gaborc… src/… curl    http… "\\"a… 3567b… 4.3.3   source     NA
-#>  4 /Users/gaborc… src/… rlang   http… "\\"b… e6973… 1.0.6   source     NA
-#>  5 /Users/gaborc… src/… openssl http… "\\"1… 7cde9… 2.0.3   source     NA
-#>  6 /Users/gaborc… src/… tinytex http… "\\"8… 205f7… 0.42    source     NA
-#>  7 /Users/gaborc… src/… evalua… http… "\\"6… 49c74… 0.17    source     NA
-#>  8 /Users/gaborc… src/… Rcpp    http… "\\"2… 807ce… 1.0.9   source     NA
-#>  9 /Users/gaborc… src/… knitr   http… "\\"d… 9b8f9… 1.40    source     NA
-#> 10 /Users/gaborc… src/… lpSolve http… "\\"7… f7258… 5.6.17  source     NA
-#> # … with 59 more rows, 2 more variables: vignettes <int>,               
-#> #   rversion <chr>, and abbreviated variable name ¹​platform            
-
-}} +\if{html}{\out{
}}\preformatted{cache_summary() +}\if{html}{\out{
}} + + + +\if{html}{\out{
}}\preformatted{cache_list() +}\if{html}{\out{
}} + +\if{html}{\out{
}}\preformatted{cache_list(package = "recipes") +}\if{html}{\out{
}} + +\if{html}{\out{
}}\preformatted{cache_list(platform = "source") +}\if{html}{\out{
}} diff --git a/man/faq.Rd b/man/faq.Rd index 3646eaffd..e69fe4a50 100644 --- a/man/faq.Rd +++ b/man/faq.Rd @@ -14,58 +14,11 @@ Sometimes you still want a reinstall, e.g. to fix a broken installation. In this case you can delete the package and then install it, or use the \code{?reinstall} parameter: -\if{html}{\out{
}}\preformatted{pak::pkg_install("tibble") -}\if{html}{\out{
}}\if{html}{\out{ -
-#>                                                                         
-#> → Will install 13 packages.                                             
-#> → All 13 packages (7.68 MB) are cached.                                 
-#> + cli         3.3.0                                                     
-#> + crayon      1.5.1                                                     
-#> + ellipsis    0.3.2                                                     
-#> + fansi       1.0.3                                                     
-#> + glue        1.6.2                                                     
-#> + lifecycle   1.0.1                                                     
-#> + magrittr    2.0.3                                                     
-#> + pillar      1.7.0                                                     
-#> + pkgconfig   2.0.3                                                     
-#> + rlang       1.0.2                                                     
-#> + tibble      3.1.7                                                     
-#> + utf8        1.2.2                                                     
-#> + vctrs       0.4.1                                                     
-#>  No downloads are needed, 13 pkgs (7.68 MB) are cached                 
-#>  Got utf8 1.2.2 (aarch64-apple-darwin20) (209.24 kB)                   
-#>  Installed cli 3.3.0  (76ms)                                           
-#>  Installed crayon 1.5.1  (87ms)                                        
-#>  Installed ellipsis 0.3.2  (97ms)                                      
-#>  Installed fansi 1.0.3  (103ms)                                        
-#>  Installed glue 1.6.2  (111ms)                                         
-#>  Installed lifecycle 1.0.1  (153ms)                                    
-#>  Installed magrittr 2.0.3  (158ms)                                     
-#>  Installed pillar 1.7.0  (162ms)                                       
-#>  Installed pkgconfig 2.0.3  (87ms)                                     
-#>  Installed rlang 1.0.2  (39ms)                                         
-#>  Installed tibble 3.1.7  (41ms)                                        
-#>  Installed utf8 1.2.2  (39ms)                                          
-#>  Installed vctrs 0.4.1  (32ms)                                         
-#>  1 pkg + 12 deps: added 13, dld 1 (209.24 kB) [1.8s]                   
-
-}} - - -\if{html}{\out{
}}\preformatted{pak::pkg_install("tibble?reinstall") -}\if{html}{\out{
}}\if{html}{\out{ -
-#>                                                                         
-#> → Will install 1 package.                                               
-#> → The package (724.32 kB) is cached.                                    
-#> + tibble   3.1.7                                                        
-#>  No downloads are needed, 1 pkg (724.32 kB) is cached                  
-#>  Installed tibble 3.1.7  (42ms)                                        
-#>  1 pkg + 12 deps: kept 11, added 1 [343ms]                             
-
-}} +\if{html}{\out{
}}\preformatted{pak::pkg_install("tibble") +}\if{html}{\out{
}} +\if{html}{\out{
}}\preformatted{pak::pkg_install("tibble?reinstall") +}\if{html}{\out{
}} } \subsection{How do I install a dependency from a binary package}{ @@ -87,21 +40,8 @@ with \code{pkg = NULL}, so for these you need to explicitly use \code{upgrade = To force the installation of a source package (instead of a binary package), use the \code{?source} parameter: -\if{html}{\out{
}}\preformatted{pak::pkg_install("tibble?source") -}\if{html}{\out{
}}\if{html}{\out{ -
-#>                                                                         
-#> → Will install 1 package.                                               
-#> → The package (672.34 kB) is cached.                                    
-#> + tibble   3.1.7 👷🏼‍♀️🔧                                                 
-#>  No downloads are needed, 1 pkg (672.34 kB) is cached                  
-#>  Building tibble 3.1.7                                                 
-#>  Built tibble 3.1.7 (3.1s)                                             
-#>  Installed tibble 3.1.7  (35ms)                                        
-#>  1 pkg + 12 deps: kept 11, added 1 [4.1s]                              
-
-}} - +\if{html}{\out{
}}\preformatted{pak::pkg_install("tibble?source") +}\if{html}{\out{
}} } \subsection{How do I install the latest version of a dependency?}{ @@ -112,37 +52,17 @@ parameter with the \verb{=} form: \verb{=?source}. For example to install tibble, with its cli dependency installed from source you could write: -\if{html}{\out{
}}\preformatted{pak::pkg_install(c("tibble", "cli=?source")) -}\if{html}{\out{
}}\if{html}{\out{ -
-#>                                                                         
-#> → Will install 1 package.                                               
-#> → The package (540.04 kB) is cached.                                    
-#> + cli   3.3.0 👷🏽🔧                                                       
-#>  No downloads are needed, 1 pkg (540.04 kB) is cached                  
-#>  Building cli 3.3.0                                                    
-#>  Built cli 3.3.0 (4.5s)                                                
-#>  Installed cli 3.3.0  (68ms)                                           
-#>  1 pkg + 12 deps: kept 11, added 1 [4.9s]                              
-
-}} - +\if{html}{\out{
}}\preformatted{pak::pkg_install(c("tibble", "cli=?source")) +}\if{html}{\out{
}} } \subsection{How do I ignore an optional dependency?}{ -\if{html}{\out{
}}\preformatted{pak::pkg_install( +\if{html}{\out{
}}\preformatted{pak::pkg_install( c("tibble", "DiagrammeR=?ignore", "formattable=?ignore"), dependencies = TRUE ) -}\if{html}{\out{
}}\if{html}{\out{ -
-#>                                                                         
-#>  No downloads are needed                                               
-#>  1 pkg + 12 deps: kept 12 [583ms]                                      
-
-}} - +}\if{html}{\out{
}} The syntax is diff --git a/man/get-started.Rd b/man/get-started.Rd index e9140ad4c..b231669ef 100644 --- a/man/get-started.Rd +++ b/man/get-started.Rd @@ -10,40 +10,17 @@ This manual page collects the most common pak use cases. \section{Package installation}{ \subsection{Install a package from CRAN or Bioconductor}{ -\if{html}{\out{
}}\preformatted{pak::pkg_install("tibble") +\if{html}{\out{
}}\preformatted{pak::pkg_install("tibble") }\if{html}{\out{
}} -\if{html}{\figure{tldr-cran.svg}} - pak automatically sets a CRAN repository and the Bioconductor repositories that correspons to the current R version. } \subsection{Install a package from GitHub}{ -\if{html}{\out{
}}\preformatted{pak::pkg_install("tidyverse/tibble") -}\if{html}{\out{
}}\if{html}{\out{ -
-#>                                                                         
-#> → Will update 2 packages.                                               
-#> → All 2 packages (0 B) are cached.                                      
-#> + tibble 3.1.8 → 3.1.8.9002 👷🏻🔧 (GitHub: 37ec86a)                       
-#> + vctrs  0.5.1 → 0.5.1.9000 👷🏾‍♀️🔧 (GitHub: 2d7de76)                    
-#>  No downloads are needed, 2 pkgs are cached                            
-#>  Packaging vctrs 0.5.1.9000                                            
-#>  Packaged vctrs 0.5.1.9000 (1.4s)                                      
-#>  Building vctrs 0.5.1.9000                                             
-#>  Built vctrs 0.5.1.9000 (11.2s)                                        
-#>  Installed vctrs 0.5.1.9000 (github::r-lib/vctrs@2d7de76) (34ms)       
-#>  Packaging tibble 3.1.8.9002                                           
-#>  Packaged tibble 3.1.8.9002 (502ms)                                    
-#>  Building tibble 3.1.8.9002                                            
-#>  Built tibble 3.1.8.9002 (2.7s)                                        
-#>  Installed tibble 3.1.8.9002 (github::tidyverse/tibble@37ec86a) (28ms) 
-#>  1 pkg + 10 deps: kept 9, upd 2 [17.5s]                                
-
-}} - +\if{html}{\out{
}}\preformatted{pak::pkg_install("tidyverse/tibble") +}\if{html}{\out{
}} Use the \code{user/repo} form. You can specify a branch or tag: \code{user/repo@branch} or \code{user/repo@tag}. @@ -51,26 +28,10 @@ You can specify a branch or tag: \code{user/repo@branch} or \code{user/repo@tag} \subsection{Install a package from a URL}{ -\if{html}{\out{
}}\preformatted{pak::pkg_install( +\if{html}{\out{
}}\preformatted{pak::pkg_install( "url::https://cran.r-project.org/src/contrib/Archive/tibble/tibble_3.1.7.tar.gz" ) -}\if{html}{\out{
}}\if{html}{\out{ -
-#>                                                                         
-#> → Will install 1 package.                                               
-#> → Will update 1 package.                                                
-#> → All 2 packages (38.65 kB) are cached.                                 
-#> + ellipsis              0.3.2                                           
-#> + tibble   3.1.8.9002 → 3.1.7 👷🏻‍♀️🔧                                    
-#>  No downloads are needed, 2 pkgs (38.65 kB) are cached                 
-#>  Installed ellipsis 0.3.2  (18ms)                                      
-#>  Building tibble 3.1.7                                                 
-#>  Built tibble 3.1.7 (2.5s)                                             
-#>  Installed tibble 3.1.7  (31ms)                                        
-#>  1 pkg + 11 deps: kept 10, upd 1, added 1 [3.3s]                       
-
-}} - +}\if{html}{\out{
}} The URL may point to an R package file, made with \verb{R CMD build}, or a \code{.tar.gz} or \code{.zip} archive of a package tree. @@ -80,34 +41,16 @@ The URL may point to an R package file, made with \verb{R CMD build}, or a \section{Package updates}{ \subsection{Update a package}{ -\if{html}{\out{
}}\preformatted{pak::pkg_install("tibble") -}\if{html}{\out{
}}\if{html}{\out{ -
-#>                                                                         
-#> → Will update 1 package.                                                
-#> → The package (724.32 kB) is cached.                                    
-#> + tibble 3.1.7 → 3.1.8                                                  
-#>  No downloads are needed, 1 pkg (724.32 kB) is cached                  
-#>  Installed tibble 3.1.8  (36ms)                                        
-#>  1 pkg + 10 deps: kept 10, upd 1 [368ms]                               
-
-}} - +\if{html}{\out{
}}\preformatted{pak::pkg_install("tibble") +}\if{html}{\out{
}} \code{pak::pkg_install()} automatically updates the package. } \subsection{Update all dependencies of a package}{ -\if{html}{\out{
}}\preformatted{pak::pkg_install("tibble", upgrade = TRUE) -}\if{html}{\out{
}}\if{html}{\out{ -
-#>                                                                         
-#>  No downloads are needed                                               
-#>  1 pkg + 10 deps: kept 11 [278ms]                                      
-
-}} - +\if{html}{\out{
}}\preformatted{pak::pkg_install("tibble", upgrade = TRUE) +}\if{html}{\out{
}} \code{upgrade = TRUE} updates the package itself and all of its dependencies, if necessary. @@ -117,124 +60,32 @@ necessary. Add \code{?reinstall} to the package name or package reference in general: -\if{html}{\out{
}}\preformatted{pak::pkg_install("tibble?reinstall") -}\if{html}{\out{
}}\if{html}{\out{ -
-#>                                                                         
-#> → Will install 1 package.                                               
-#> → The package (724.32 kB) is cached.                                    
-#> + tibble   3.1.8                                                        
-#>  No downloads are needed, 1 pkg (724.32 kB) is cached                  
-#>  Installed tibble 3.1.8  (60ms)                                        
-#>  1 pkg + 10 deps: kept 10, added 1 [340ms]                             
-
-}} - +\if{html}{\out{
}}\preformatted{pak::pkg_install("tibble?reinstall") +}\if{html}{\out{
}} } } \section{Dependency lookup}{ \subsection{Dependencies of a CRAN or Bioconductor package}{ -\if{html}{\out{
}}\preformatted{pak::pkg_deps("tibble") -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 11 × 32                                                 
-#>    ref       type  direct direc…¹ status package version license needs…²
-#>    <chr>     <chr> <lgl>  <lgl>   <chr>  <chr>   <chr>   <chr>   <lgl>  
-#>  1 cli       stan… FALSE  FALSE   OK     cli     3.4.1   MIT + … FALSE  
-#>  2 fansi     stan… FALSE  FALSE   OK     fansi   1.0.3   GPL-2 … FALSE  
-#>  3 glue      stan… FALSE  FALSE   OK     glue    1.6.2   MIT + … FALSE  
-#>  4 lifecycle stan… FALSE  FALSE   OK     lifecy… 1.0.3   MIT + … FALSE  
-#>  5 magrittr  stan… FALSE  FALSE   OK     magrit… 2.0.3   MIT + … FALSE  
-#>  6 pillar    stan… FALSE  FALSE   OK     pillar  1.8.1   MIT + … FALSE  
-#>  7 pkgconfig stan… FALSE  FALSE   OK     pkgcon… 2.0.3   MIT + … FALSE  
-#>  8 rlang     stan… FALSE  FALSE   OK     rlang   1.0.6   MIT + … FALSE  
-#>  9 tibble    stan… TRUE   TRUE    OK     tibble  3.1.8   MIT + … FALSE  
-#> 10 utf8      stan… FALSE  FALSE   OK     utf8    1.2.2   Apache… FALSE  
-#> 11 vctrs     stan… FALSE  FALSE   OK     vctrs   0.5.1   MIT + … FALSE  
-#> # … with 23 more variables: priority <chr>, md5sum <chr>, sha256 <chr>, 
-#> #   filesize <int>, built <chr>, platform <chr>, rversion <chr>,        
-#> #   repotype <chr>, repodir <chr>, target <chr>, deps <list>,           
-#> #   mirror <chr>, sources <list>, remote <list>, error <list>,          
-#> #   metadata <list>, dep_types <list>, params <list>, sysreqs <chr>,    
-#> #   cache_status <chr>, lib_status <chr>, old_version <chr>,            
-#> #   new_version <chr>, and abbreviated variable names ¹​directpkg, …    
-
-}} - +\if{html}{\out{
}}\preformatted{pak::pkg_deps("tibble") +}\if{html}{\out{
}} The results are returned in a data frame. } \subsection{Dependency tree of a CRAN / Bioconductor package}{ -\if{html}{\out{
}}\preformatted{pak::pkg_deps_tree("tibble") -}\if{html}{\out{
}}\if{html}{\out{ -
-#> tibble 3.1.8                                                           
-#> ├─fansi 1.0.3                                                          
-#> ├─lifecycle 1.0.3                                                      
-#> │ ├─cli 3.4.1                                                          
-#> │ ├─glue 1.6.2                                                         
-#> │ └─rlang 1.0.6                                                        
-#> ├─magrittr 2.0.3                                                       
-#> ├─pillar 1.8.1                                                         
-#> │ ├─cli                                                                 
-#> │ ├─fansi                                                               
-#> │ ├─glue                                                                
-#> │ ├─lifecycle                                                           
-#> │ ├─rlang                                                               
-#> │ ├─utf8 1.2.2                                                         
-#> │ └─vctrs 0.5.1                                                        
-#> │   ├─cli                                                               
-#> │   ├─glue                                                              
-#> │   ├─lifecycle                                                         
-#> │   └─rlang                                                             
-#> ├─pkgconfig 2.0.3                                                      
-#> ├─rlang                                                                 
-#> └─vctrs                                                                 
-#>                                                                         
-#> Key:   new                                                             
-
-}} - +\if{html}{\out{
}}\preformatted{pak::pkg_deps_tree("tibble") +}\if{html}{\out{
}} The results are also silently returned in a data frame. } \subsection{Dependency tree of a package on GitHub}{ -\if{html}{\out{
}}\preformatted{pak::pkg_deps_tree("tidyverse/tibble") -}\if{html}{\out{
}}\if{html}{\out{ -
-#> tidyverse/tibble 3.1.8.9002 ✨👷🏼🔧                                        
-#> ├─fansi 1.0.3                                                          
-#> ├─lifecycle 1.0.3                                                      
-#> │ ├─cli 3.4.1                                                          
-#> │ ├─glue 1.6.2                                                         
-#> │ └─rlang 1.0.6                                                        
-#> ├─magrittr 2.0.3                                                       
-#> ├─pillar 1.8.1                                                         
-#> │ ├─cli                                                                 
-#> │ ├─fansi                                                               
-#> │ ├─glue                                                                
-#> │ ├─lifecycle                                                           
-#> │ ├─rlang                                                               
-#> │ ├─utf8 1.2.2                                                         
-#> │ └─r-lib/vctrs 0.5.1.9000 ✨👷🏼🔧                                         
-#> │   ├─cli                                                               
-#> │   ├─glue                                                              
-#> │   ├─lifecycle                                                         
-#> │   └─rlang                                                             
-#> ├─pkgconfig 2.0.3                                                      
-#> ├─rlang                                                                 
-#> └─r-lib/vctrs                                                           
-#>                                                                         
-#> Key:   new | 👷🏼 build | 🔧 compile                                      
-
-}} - +\if{html}{\out{
}}\preformatted{pak::pkg_deps_tree("tidyverse/tibble") +}\if{html}{\out{
}} Use the \code{user/repo} form. As usual, you can also select a branch, tag, or sha, with the @@ -243,36 +94,8 @@ As usual, you can also select a branch, tag, or sha, with the \subsection{Dependency tree of the package in the current directory}{ -\if{html}{\out{
}}\preformatted{pak::local_deps_tree("tibble") -}\if{html}{\out{
}}\if{html}{\out{ -
-#> local::tibble 3.1.8 ✨👷🏻‍♀️🔧                                             
-#> ├─fansi 1.0.3                                                          
-#> ├─lifecycle 1.0.3                                                      
-#> │ ├─cli 3.4.1                                                          
-#> │ ├─glue 1.6.2                                                         
-#> │ └─rlang 1.0.6                                                        
-#> ├─magrittr 2.0.3                                                       
-#> ├─pillar 1.8.1                                                         
-#> │ ├─cli                                                                 
-#> │ ├─fansi                                                               
-#> │ ├─glue                                                                
-#> │ ├─lifecycle                                                           
-#> │ ├─rlang                                                               
-#> │ ├─utf8 1.2.2                                                         
-#> │ └─vctrs 0.5.1                                                        
-#> │   ├─cli                                                               
-#> │   ├─glue                                                              
-#> │   ├─lifecycle                                                         
-#> │   └─rlang                                                             
-#> ├─pkgconfig 2.0.3                                                      
-#> ├─rlang                                                                 
-#> └─vctrs                                                                 
-#>                                                                         
-#> Key:   new | 👷🏻‍♀️ build | 🔧 compile                                   
-
-}} - +\if{html}{\out{
}}\preformatted{pak::local_deps_tree("tibble") +}\if{html}{\out{
}} Assuming package is in directory \code{tibble}. } @@ -281,20 +104,8 @@ Assuming package is in directory \code{tibble}. How does tibble depend on rlang? -\if{html}{\out{
}}\preformatted{pak::pkg_deps_explain("tibble", "rlang") -}\if{html}{\out{
}}\if{html}{\out{ -
-#> tibble -> lifecycle -> rlang                                            
-#> tibble -> pillar -> lifecycle -> rlang                                  
-#> tibble -> pillar -> rlang                                               
-#> tibble -> pillar -> vctrs -> lifecycle -> rlang                         
-#> tibble -> pillar -> vctrs -> rlang                                      
-#> tibble -> rlang                                                         
-#> tibble -> vctrs -> lifecycle -> rlang                                   
-#> tibble -> vctrs -> rlang                                                
-
-}} - +\if{html}{\out{
}}\preformatted{pak::pkg_deps_explain("tibble", "rlang") +}\if{html}{\out{
}} Use can also use the \code{user/repo} form for packages from GitHub, \code{url::...} for packages at URLs, etc. @@ -304,243 +115,20 @@ Use can also use the \code{user/repo} form for packages from GitHub, \section{Package development}{ \subsection{Install dependencies of local package}{ -\if{html}{\out{
}}\preformatted{pak::local_install_deps() -}\if{html}{\out{
}}\if{html}{\out{ -
-#>  Loading metadata database ... done                                    
-#>                                                                         
-#> → The package (0 B) is cached.                                          
-#>  No downloads are needed                                               
-#>  10 deps: kept 10 [3.2s]                                               
-
-}} - +\if{html}{\out{
}}\preformatted{pak::local_install_deps() +}\if{html}{\out{
}} } \subsection{Install local package}{ -\if{html}{\out{
}}\preformatted{pak::local_install() -}\if{html}{\out{
}}\if{html}{\out{ -
-#>                                                                         
-#> → Will update 1 package.                                                
-#> → The package (0 B) is cached.                                          
-#> + tibble 3.1.8 → 3.1.8 👷🏻‍♂️🔧                                           
-#>  No downloads are needed, 1 pkg is cached                              
-#>  Got tibble 3.1.8 (source) (96 B)                                      
-#>  Packaging tibble 3.1.8                                                
-#>  Packaged tibble 3.1.8 (864ms)                                         
-#>  Building tibble 3.1.8                                                 
-#>  Built tibble 3.1.8 (2.4s)                                             
-#>  Installed tibble 3.1.8 (local) (38ms)                                 
-#>  1 pkg + 10 deps: kept 10, upd 1, dld 1 (NA B) [4.2s]                  
-
-}} - +\if{html}{\out{
}}\preformatted{pak::local_install() +}\if{html}{\out{
}} } \subsection{Install all dependencies of local package}{ -\if{html}{\out{
}}\preformatted{pak::local_install_dev_deps() -}\if{html}{\out{
}}\if{html}{\out{ -
-#>                                                                         
-#> → Will install 86 packages.                                             
-#> → Will update 2 packages.                                               
-#> → All 89 packages (100.53 MB) are cached.                               
-#> + askpass                1.1                                            
-#> + base64enc              0.1-3                                          
-#> + bench                  1.1.2                                          
-#> + bit                    4.0.5                                          
-#> + bit64                  4.0.5                                          
-#> + blob                   1.2.3                                          
-#> + brio                   1.1.3                                          
-#> + bslib                  0.4.1                                          
-#> + cachem                 1.0.6                                          
-#> + callr                  3.7.3                                          
-#> + clipr                  0.8.0                                          
-#> + colorspace             2.0-3                                          
-#> + covr                   3.6.1                                          
-#> + crayon                 1.5.2                                          
-#> + curl                   4.3.3                                          
-#> + desc                   1.4.2                                          
-#> + DiagrammeR             1.0.9                                          
-#> + diffobj                0.3.5                                          
-#> + digest                 0.6.31                                         
-#> + downloader             0.4                                            
-#> + dplyr                  1.0.10                                         
-#> + evaluate               0.19    👷🏿‍♂️                                  
-#> + farver                 2.1.1                                          
-#> + fastmap                1.1.0                                          
-#> + formattable            0.2.1                                          
-#> + fs                     1.5.2                                          
-#> + generics               0.1.3                                          
-#> + ggplot2                3.4.0                                          
-#> + gridExtra              2.3                                            
-#> + gtable                 0.3.1                                          
-#> + highr                  0.9                                            
-#> + hms                    1.1.2                                          
-#> + htmltools              0.5.4                                          
-#> + htmlwidgets            1.6.0   👷🏾‍♂️                                  
-#> + httr                   1.4.4                                          
-#> + igraph                 1.3.5                                          
-#> + influenceR             0.1.0.1                                        
-#> + isoband                0.2.6                                          
-#> + jquerylib              0.1.4                                          
-#> + jsonlite               1.8.4                                          
-#> + knitr                  1.41                                           
-#> + labeling               0.4.2                                          
-#> + lazyeval               0.2.2                                          
-#> + lubridate              1.9.0                                          
-#> + Matrix       1.5-1   → 1.5-3                                          
-#> + memoise                2.0.1                                          
-#> + mime                   0.12                                           
-#> + mockr                  0.2.0                                          
-#> + munsell                0.5.0                                          
-#> + nlme         3.1-160 → 3.1-161 👷‍♂️🔧                                  
-#> + nycflights13           1.0.2                                          
-#> + openssl                2.0.5                                          
-#> + pkgbuild               1.4.0                                          
-#> + pkgload                1.3.2                                          
-#> + praise                 1.0.0                                          
-#> + prettyunits            1.1.1                                          
-#> + processx               3.8.0                                          
-#> + profmem                0.6.0                                          
-#> + ps                     1.7.2                                          
-#> + purrr                  0.3.5                                          
-#> + R6                     2.5.1                                          
-#> + rappdirs               0.3.3                                          
-#> + RColorBrewer           1.1-3                                          
-#> + readr                  2.1.3                                          
-#> + rematch2               2.1.2                                          
-#> + rex                    1.2.1                                          
-#> + rmarkdown              2.19    👷‍♂️                                   
-#> + rprojroot              2.0.3                                          
-#> + rstudioapi             0.14                                           
-#> + sass                   0.4.4                                          
-#> + scales                 1.2.1                                          
-#> + stringi                1.7.8                                          
-#> + stringr                1.5.0                                          
-#> + sys                    3.4.1                                          
-#> + testthat               3.1.6                                          
-#> + tidyr                  1.2.1                                          
-#> + tidyselect             1.2.0                                          
-#> + timechange             0.1.1                                          
-#> + tinytex                0.43    👷🏻‍♂️                                  
-#> + tzdb                   0.3.0                                          
-#> + viridis                0.6.2                                          
-#> + viridisLite            0.4.1                                          
-#> + visNetwork             2.1.2                                          
-#> + vroom                  1.6.0                                          
-#> + waldo                  0.4.0                                          
-#> + withr                  2.5.0                                          
-#> + xfun                   0.35                                           
-#> + yaml                   2.3.6                                          
-#>  No downloads are needed, 88 pkgs (100.53 MB) are cached               
-#>  Packaging tibble 3.1.8                                                
-#>  Building evaluate 0.19                                                
-#>  Building nlme 3.1-161                                                 
-#>  Installed R6 2.5.1  (31ms)                                            
-#>  Installed DiagrammeR 1.0.9  (76ms)                                    
-#>  Installed RColorBrewer 1.1-3  (72ms)                                  
-#>  Installed askpass 1.1  (79ms)                                         
-#>  Installed Matrix 1.5-3  (137ms)                                       
-#>  Installed base64enc 0.1-3  (125ms)                                    
-#>  Installed bench 1.1.2  (90ms)                                         
-#>  Installed bit64 4.0.5  (44ms)                                         
-#>  Installed bit 4.0.5  (43ms)                                           
-#>  Installed blob 1.2.3  (41ms)                                          
-#>  Installed brio 1.1.3  (40ms)                                          
-#>  Installed cachem 1.0.6  (31ms)                                        
-#>  Installed callr 3.7.3  (53ms)                                         
-#>  Installed clipr 0.8.0  (89ms)                                         
-#>  Installed colorspace 2.0-3  (99ms)                                    
-#>  Installed covr 3.6.1  (58ms)                                          
-#>  Installed crayon 1.5.2  (75ms)                                        
-#>  Installed curl 4.3.3  (83ms)                                          
-#>  Packaged tibble 3.1.8 (684ms)                                         
-#>  Installed bslib 0.4.1  (315ms)                                        
-#>  Installed desc 1.4.2  (77ms)                                          
-#>  Installed diffobj 0.3.5  (68ms)                                       
-#>  Installed digest 0.6.31  (60ms)                                       
-#>  Installed downloader 0.4  (39ms)                                      
-#>  Installed dplyr 1.0.10  (39ms)                                        
-#>  Installed farver 2.1.1  (41ms)                                        
-#>  Installed fastmap 1.1.0  (38ms)                                       
-#>  Installed formattable 0.2.1  (43ms)                                   
-#>  Built evaluate 0.19 (903ms)                                           
-#>  Installed fs 1.5.2  (49ms)                                            
-#>  Installed generics 0.1.3  (46ms)                                      
-#>  Installed ggplot2 3.4.0  (65ms)                                       
-#>  Installed gridExtra 2.3  (43ms)                                       
-#>  Installed gtable 0.3.1  (38ms)                                        
-#>  Installed highr 0.9  (37ms)                                           
-#>  Installed hms 1.1.2  (39ms)                                           
-#>  Installed htmltools 0.5.4  (40ms)                                     
-#>  Installed httr 1.4.4  (40ms)                                          
-#>  Installed influenceR 0.1.0.1  (17ms)                                  
-#>  Installed igraph 1.3.5  (96ms)                                        
-#>  Installed isoband 0.2.6  (68ms)                                       
-#>  Installed jquerylib 0.1.4  (38ms)                                     
-#>  Installed jsonlite 1.8.4  (37ms)                                      
-#>  Installed labeling 0.4.2  (14ms)                                      
-#>  Installed knitr 1.41  (73ms)                                          
-#>  Installed lazyeval 0.2.2  (43ms)                                      
-#>  Installed lubridate 1.9.0  (38ms)                                     
-#>  Installed memoise 2.0.1  (39ms)                                       
-#>  Installed mime 0.12  (58ms)                                           
-#>  Installed mockr 0.2.0  (38ms)                                         
-#>  Installed munsell 0.5.0  (36ms)                                       
-#>  Installed nycflights13 1.0.2  (37ms)                                  
-#>  Installed openssl 2.0.5  (41ms)                                       
-#>  Installed pkgbuild 1.4.0  (39ms)                                      
-#>  Installed pkgload 1.3.2  (37ms)                                       
-#>  Installed praise 1.0.0  (35ms)                                        
-#>  Installed prettyunits 1.1.1  (56ms)                                   
-#>  Installed processx 3.8.0  (37ms)                                      
-#>  Installed profmem 0.6.0  (37ms)                                       
-#>  Installed ps 1.7.2  (37ms)                                            
-#>  Installed purrr 0.3.5  (38ms)                                         
-#>  Installed rappdirs 0.3.3  (37ms)                                      
-#>  Installed readr 2.1.3  (42ms)                                         
-#>  Installed rematch2 2.1.2  (41ms)                                      
-#>  Installed rex 1.2.1  (58ms)                                           
-#>  Installed rprojroot 2.0.3  (58ms)                                     
-#>  Installed rstudioapi 0.14  (40ms)                                     
-#>  Installed sass 0.4.4  (42ms)                                          
-#>  Installed scales 1.2.1  (39ms)                                        
-#>  Installed stringr 1.5.0  (33ms)                                       
-#>  Installed sys 3.4.1  (49ms)                                           
-#>  Installed testthat 3.1.6  (88ms)                                      
-#>  Installed tidyr 1.2.1  (77ms)                                         
-#>  Installed stringi 1.7.8  (195ms)                                      
-#>  Installed tidyselect 1.2.0  (113ms)                                   
-#>  Installed timechange 0.1.1  (55ms)                                    
-#>  Installed tzdb 0.3.0  (40ms)                                          
-#>  Installed viridisLite 0.4.1  (39ms)                                   
-#>  Installed viridis 0.6.2  (39ms)                                       
-#>  Installed visNetwork 2.1.2  (77ms)                                    
-#>  Installed vroom 1.6.0  (77ms)                                         
-#>  Installed waldo 0.4.0  (62ms)                                         
-#>  Installed withr 2.5.0  (40ms)                                         
-#>  Installed xfun 0.35  (39ms)                                           
-#>  Building tinytex 0.43                                                 
-#>  Installed yaml 2.3.6  (43ms)                                          
-#>  Installed evaluate 0.19  (15ms)                                       
-#>  Built tinytex 0.43 (1.1s)                                             
-#>  Installed tinytex 0.43  (15ms)                                        
-#>  Building rmarkdown 2.19                                               
-#>  Built rmarkdown 2.19 (3.9s)                                           
-#>  Installed rmarkdown 2.19  (85ms)                                      
-#>  Building htmlwidgets 1.6.0                                            
-#>  Built nlme 3.1-161 (8s)                                               
-#>  Installed nlme 3.1-161  (33ms)                                        
-#>  Built htmlwidgets 1.6.0 (1.1s)                                        
-#>  Installed htmlwidgets 1.6.0  (22ms)                                   
-#>  103 deps: kept 15, upd 2, added 86 [10.2s]                            
-
-}} - +\if{html}{\out{
}}\preformatted{pak::local_install_dev_deps() +}\if{html}{\out{
}} Installs development and optional dependencies as well. } @@ -549,21 +137,8 @@ Installs development and optional dependencies as well. \section{Repositories}{ \subsection{List current repositories}{ -\if{html}{\out{
}}\preformatted{pak::repo_get() -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 5 × 5                                                   
-#>   name          url                                type  r_ver…¹ bioc_…²
-#> * <chr>         <chr>                              <chr> <chr>   <chr>  
-#> 1 CRAN          https://cloud.r-project.org        cran  *       NA     
-#> 2 BioCsoft      https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> 3 BioCann       https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> 4 BioCexp       https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> 5 BioCworkflows https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> # … with abbreviated variable names ¹​r_version, ²​bioc_version         
-
-}} - +\if{html}{\out{
}}\preformatted{pak::repo_get() +}\if{html}{\out{
}} If you haven't set a CRAN or Bioconductor repository, pak does that automatically. @@ -571,43 +146,16 @@ automatically. \subsection{Add custom repository}{ -\if{html}{\out{
}}\preformatted{pak::repo_add(rhub = 'https://r-hub.r-universe.dev') +\if{html}{\out{
}}\preformatted{pak::repo_add(rhub = 'https://r-hub.r-universe.dev') pak::repo_get() -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 6 × 5                                                   
-#>   name          url                                type  r_ver…¹ bioc_…²
-#> * <chr>         <chr>                              <chr> <chr>   <chr>  
-#> 1 CRAN          https://cloud.r-project.org        cran  *       NA     
-#> 2 rhub          https://r-hub.r-universe.dev       cran… *       NA     
-#> 3 BioCsoft      https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> 4 BioCann       https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> 5 BioCexp       https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> 6 BioCworkflows https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> # … with abbreviated variable names ¹​r_version, ²​bioc_version         
-
-}} - +}\if{html}{\out{
}} } \subsection{Remove custom repositories}{ -\if{html}{\out{
}}\preformatted{options(repos = getOption("repos")["CRAN"]) +\if{html}{\out{
}}\preformatted{options(repos = getOption("repos")["CRAN"]) pak::repo_get() -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 5 × 5                                                   
-#>   name          url                                type  r_ver…¹ bioc_…²
-#> * <chr>         <chr>                              <chr> <chr>   <chr>  
-#> 1 CRAN          https://cloud.r-project.org        cran  *       NA     
-#> 2 BioCsoft      https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> 3 BioCann       https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> 4 BioCexp       https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> 5 BioCworkflows https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> # … with abbreviated variable names ¹​r_version, ²​bioc_version         
-
-}} - +}\if{html}{\out{
}} If you set the \code{repos} option to a CRAN repo only, or unset it completely, then pak keeps only CRAN and (by default) Bioconductor. @@ -615,22 +163,9 @@ then pak keeps only CRAN and (by default) Bioconductor. \subsection{Time travel using RSPM}{ -\if{html}{\out{
}}\preformatted{pak::repo_add(CRAN = "RSPM@2022-06-30") +\if{html}{\out{
}}\preformatted{pak::repo_add(CRAN = "RSPM@2022-06-30") pak::repo_get() -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 5 × 5                                                   
-#>   name          url                                type  r_ver…¹ bioc_…²
-#> * <chr>         <chr>                              <chr> <chr>   <chr>  
-#> 1 CRAN          https://packagemanager.posit.co/c… cran  *       NA     
-#> 2 BioCsoft      https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> 3 BioCann       https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> 4 BioCexp       https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> 5 BioCworkflows https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> # … with abbreviated variable names ¹​r_version, ²​bioc_version         
-
-}} - +}\if{html}{\out{
}} Sets a repository that is equivalent to CRAN's state closest to the specified date. @@ -640,22 +175,9 @@ repository. \subsection{Time travel using MRAN}{ -\if{html}{\out{
}}\preformatted{pak::repo_add(CRAN = "MRAN@2022-06-30") +\if{html}{\out{
}}\preformatted{pak::repo_add(CRAN = "MRAN@2022-06-30") pak::repo_get() -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 5 × 5                                                   
-#>   name          url                                type  r_ver…¹ bioc_…²
-#> * <chr>         <chr>                              <chr> <chr>   <chr>  
-#> 1 CRAN          https://cran.microsoft.com/snapsh… cran  *       NA     
-#> 2 BioCsoft      https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> 3 BioCann       https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> 4 BioCexp       https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> 5 BioCworkflows https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> # … with abbreviated variable names ¹​r_version, ²​bioc_version         
-
-}} - +}\if{html}{\out{
}} Sets a repository that is equivalent to CRAN's state at the specified date. Name this repository \code{CRAN}, otherwise pak will also add a default CRAN @@ -667,34 +189,8 @@ repository. By default pak caches both metadata and downloaded packages. \subsection{Inspect metadata cache}{ -\if{html}{\out{
}}\preformatted{pak::meta_list() -}\if{html}{\out{
}}\if{html}{\out{ -
-#>  Updated metadata database: 4.55 MB in 4 files.                        
-#>  Updating metadata database ... done                                   
-#> # A data frame: 43,718 × 32                                             
-#>    package version depends sugge…¹ license imports linki…² archs enhan…³
-#>    <chr>   <chr>   <chr>   <chr>   <chr>   <chr>   <chr>   <chr> <chr>  
-#>  1 A3      1.0.0   R (>= … random… GPL (>… NA      NA      NA    NA     
-#>  2 AATtoo… 0.0.1   R (>= … NA      GPL-3   magrit… NA      NA    NA     
-#>  3 ABACUS  1.0.0   R (>= … rmarkd… GPL-3   ggplot… NA      NA    NA     
-#>  4 ABC.RAP 0.9.0   R (>= … knitr,… GPL-3   graphi… NA      NA    NA     
-#>  5 ABCana… 1.2.1   R (>= … NA      GPL-3   plotrix NA      NA    NA     
-#>  6 ABCopt… 0.15.0  NA      testth… MIT + … Rcpp, … Rcpp    ABCo… NA     
-#>  7 ABCp2   1.2     MASS    NA      GPL-2   NA      NA      NA    NA     
-#>  8 ABHgen… 1.0.1   NA      knitr,… GPL-3   ggplot… NA      NA    NA     
-#>  9 ABPS    0.3     NA      testth… GPL (>… kernlab NA      NA    NA     
-#> 10 ACA     1.1     R (>= … NA      GPL     graphi… NA      NA    NA     
-#> # … with 43,708 more rows, 23 more variables: os_type <chr>,            
-#> #   priority <chr>, license_is_foss <chr>, license_restricts_use <chr>, 
-#> #   repodir <chr>, rversion <chr>, platform <chr>,                      
-#> #   needscompilation <chr>, ref <chr>, type <chr>, direct <lgl>,        
-#> #   status <chr>, target <chr>, mirror <chr>, sources <list>,           
-#> #   filesize <int>, sha256 <chr>, sysreqs <chr>, built <chr>,           
-#> #   published <dttm>, deps <list>, md5sum <chr>, path <chr>, and …      
-
-}} - +\if{html}{\out{
}}\preformatted{pak::meta_list() +}\if{html}{\out{
}} } \subsection{Update metadata cache}{ @@ -703,86 +199,29 @@ By default \code{pkg_install()} and similar functions automatically update the metadata for the currently set repositories if it is older than 24 hours. You can also force an update manually: -\if{html}{\out{
}}\preformatted{pak::meta_update() -}\if{html}{\out{
}}\if{html}{\out{ -
-#>  Updating metadata database ... done                                   
-
-}} - +\if{html}{\out{
}}\preformatted{pak::meta_update() +}\if{html}{\out{
}} } \subsection{Clean metadata cache}{ -\if{html}{\out{
}}\preformatted{pak::meta_clean(force = TRUE) +\if{html}{\out{
}}\preformatted{pak::meta_clean(force = TRUE) pak::meta_summary() -}\if{html}{\out{
}}\if{html}{\out{ -
-#> [1] "/Users/gaborcsardi/Library/Caches/org.R-project.R/R/pkgcache/_metad
-#> ata"                                                                    
-#>                                                                         
-#> $current_db                                                             
-#> [1] "/Users/gaborcsardi/Library/Caches/org.R-project.R/R/pkgcache/_metad
-#> ata/pkgs-d1c324e625.rds"                                                
-#>                                                                         
-#> $raw_files                                                              
-#> character(0)                                                            
-#>                                                                         
-#> $db_files                                                               
-#> character(0)                                                            
-#>                                                                         
-#> $size                                                                   
-#> [1] 0                                                                   
-#>                                                                         
-
-}} - +}\if{html}{\out{
}} } \subsection{Inspect package cache}{ Downloaded packages are also cached. -\if{html}{\out{
}}\preformatted{pak::cache_list() -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 480 × 11                                                
-#>    fullpath       path  package url   etag  sha256 version platf…¹ built
-#>    <chr>          <chr> <chr>   <chr> <chr> <chr>  <chr>   <chr>   <int>
-#>  1 /Users/gaborc… arch… NA      http… "\\"1… 0c8f0… NA      NA         NA
-#>  2 /Users/gaborc… bin/… evalua… http… "\\"1… 08a39… 0.17    aarch6…    NA
-#>  3 /Users/gaborc… bin/… crayon  http… "\\"2… 1e6d5… 1.5.2   aarch6…    NA
-#>  4 /Users/gaborc… bin/… common… http… "\\"4… 47b4a… 1.8.1   aarch6…    NA
-#>  5 /Users/gaborc… bin/… curl    http… "\\"b… 7b8ba… 4.3.3   aarch6…    NA
-#>  6 /Users/gaborc… bin/… tinytex http… "\\"2… 7e9ba… 0.42    aarch6…    NA
-#>  7 /Users/gaborc… bin/… jsonli… http… "\\"1… 68e59… 1.8.2   aarch6…    NA
-#>  8 /Users/gaborc… bin/… lifecy… http… "\\"1… 7ce27… 1.0.3   aarch6…    NA
-#>  9 /Users/gaborc… bin/… vctrs   http… "\\"1… c3a69… 0.4.2   aarch6…    NA
-#> 10 /Users/gaborc… src/… pkgcac… NA     NA   9b70a… NA      NA          0
-#> # … with 470 more rows, 2 more variables: vignettes <int>,              
-#> #   rversion <chr>, and abbreviated variable name ¹​platform            
-
-}} - +\if{html}{\out{
}}\preformatted{pak::cache_list() +}\if{html}{\out{
}} } \subsection{View a package cache summary}{ -\if{html}{\out{
}}\preformatted{pak::cache_summary() -}\if{html}{\out{
}}\if{html}{\out{ -
-#> $cachepath                                                              
-#> [1] "/Users/gaborcsardi/Library/Caches/org.R-project.R/R/pkgcache/pkg"  
-#>                                                                         
-#> $files                                                                  
-#> [1] 480                                                                 
-#>                                                                         
-#> $size                                                                   
-#> [1] 653325143                                                           
-#>                                                                         
-
-}} - +\if{html}{\out{
}}\preformatted{pak::cache_summary() +}\if{html}{\out{
}} } \subsection{Clean package cache}{ @@ -795,32 +234,8 @@ Downloaded packages are also cached. \section{Libraries}{ \subsection{List packages in a library}{ -\if{html}{\out{
}}\preformatted{pak::lib_status(Sys.getenv("R_LIBS_USER")) -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 701 × 39                                                
-#>    library   package title version depends repos…¹ license needs…² built
-#>    <chr>     <chr>   <chr> <chr>   <chr>   <chr>   <chr>   <lgl>   <chr>
-#>  1 /Users/g… abc     "Too… 2.2.1   R (>= … CRAN    GPL (>… FALSE   R 4.…
-#>  2 /Users/g… abc.da… "Dat… 1.0     R (>= … CRAN    GPL (>… FALSE   R 4.…
-#>  3 /Users/g… abind   "Com… 1.4-5   R (>= … CRAN    LGPL (… FALSE   R 4.…
-#>  4 /Users/g… ade4    "Ana… 1.7-19  R (>= … CRAN    GPL (>… TRUE    R 4.…
-#>  5 /Users/g… ape     "Ana… 5.6-2   R (>= … CRAN    GPL-2 … TRUE    R 4.…
-#>  6 /Users/g… aplot   "Dec… 0.1.7   NA      CRAN    Artist… FALSE   R 4.…
-#>  7 /Users/g… archive "Mul… 1.1.5   R (>= … CRAN    MIT + … TRUE    R 4.…
-#>  8 /Users/g… arrayh… "Con… 1.1-0   NA      CRAN    GPL     FALSE   R 4.…
-#>  9 /Users/g… arrow   "Int… 9.0.0   R (>= … CRAN    Apache… TRUE    R 4.…
-#> 10 /Users/g… arules  "Min… 1.7-5   R (>= … CRAN    GPL-3   TRUE    R 4.…
-#> # … with 691 more rows, 30 more variables: remotetype <chr>,            
-#> #   remotepkgref <chr>, remoteref <chr>, remoterepos <chr>,             
-#> #   remotepkgplatform <chr>, remotesha <chr>, imports <chr>,            
-#> #   suggests <chr>, linkingto <chr>, remotes <chr>, remotehost <chr>,   
-#> #   remoterepo <chr>, remoteusername <chr>, enhances <chr>,             
-#> #   biocviews <chr>, remoteurl <chr>, remotesubdir <chr>,               
-#> #   priority <chr>, remoteetag <chr>, remotepackaged <chr>, …           
-
-}} - +\if{html}{\out{
}}\preformatted{pak::lib_status(Sys.getenv("R_LIBS_USER")) +}\if{html}{\out{
}} Pass the directory of the library as the argument. } diff --git a/man/lib_status.Rd b/man/lib_status.Rd index 764a32c58..87993b1ea 100644 --- a/man/lib_status.Rd +++ b/man/lib_status.Rd @@ -23,31 +23,8 @@ Status of packages in a library \section{Examples}{ -\if{html}{\out{
}}\preformatted{lib_status(.Library) -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 31 × 31                                                 
-#>    library   package version prior…¹ title license sugge…² built depends
-#>    <chr>     <chr>   <chr>   <chr>   <chr> <chr>   <chr>   <chr> <chr>  
-#>  1 /Library… base    4.2.2   base    "The… Part o… methods R 4.… NA     
-#>  2 /Library… boot    1.3-28  recomm… "Boo… Unlimi… MASS, … R 4.… R (>= …
-#>  3 /Library… class   7.3-20  recomm… "Fun… GPL-2 … NA      R 4.… R (>= …
-#>  4 /Library… cluster 2.1.4   recomm… "\\"F… GPL (>… MASS, … R 4.… R (>= …
-#>  5 /Library… codeto… 0.2-18  recomm… "Cod… GPL     NA      R 4.… R (>= …
-#>  6 /Library… compil… 4.2.2   base    "The… Part o… NA      R 4.… NA     
-#>  7 /Library… datase… 4.2.2   base    "The… Part o… NA      R 4.… NA     
-#>  8 /Library… filelo… 1.0.2   NA      "Por… MIT + … callr … R 4.… NA     
-#>  9 /Library… foreign 0.8-83  recomm… "Rea… GPL (>… NA      R 4.… R (>= …
-#> 10 /Library… graphi… 4.2.2   base    "The… Part o… NA      R 4.… NA     
-#> # … with 21 more rows, 22 more variables: needscompilation <lgl>,       
-#> #   repository <chr>, imports <chr>, remotetype <chr>,                  
-#> #   remotepkgref <chr>, remoteref <chr>, remoterepos <chr>,             
-#> #   remotepkgplatform <chr>, remotesha <chr>, enhances <chr>,           
-#> #   linkingto <chr>, md5sum <chr>, platform <chr>, biocviews <chr>,     
-#> #   sysreqs <chr>, ref <chr>, type <chr>, status <chr>, rversion <chr>, 
-#> #   sources <list>, repotype <chr>, deps <list>, and abbreviated …      
-
-}} +\if{html}{\out{
}}\preformatted{lib_status(.Library) +}\if{html}{\out{
}} } \seealso{ diff --git a/man/lockfile_create.Rd b/man/lockfile_create.Rd index c75bf73c8..c0a17b457 100644 --- a/man/lockfile_create.Rd +++ b/man/lockfile_create.Rd @@ -15,12 +15,12 @@ lockfile_create( \arguments{ \item{pkg}{Package names or package references. E.g. \itemize{ -\item \code{ggplot2}: package from CRAN, Bioconductor or a CRAN-like repository +\item \code{ggplot2} or \code{cran::ggplot2}: package from CRAN, Bioconductor or a CRAN-like repository in general, -\item \code{tidyverse/ggplot2}: package from GitHub, -\item \code{tidyverse/ggplot2@v3.4.0}: package from GitHub tag or branch, -\item \verb{https://examples.com/.../ggplot2_3.3.6.tar.gz}: package from URL, -\item \code{.}: package in the current working directory. +\item \code{tidyverse/ggplot2} or \code{github::tidyverse/ggplot2}: package from GitHub, +\item \code{tidyverse/ggplot2@v3.4.0} or \code{github::tidyverse/ggplot2@v3.4.0}: package from GitHub tag or branch, +\item \verb{url::https://examples.com/.../ggplot2_3.3.6.tar.gz}: package from URL, +\item \code{.} or \code{local::.}: package in the current working directory. } See "\link{Package sources}" for more details.} diff --git a/man/metadata.Rd b/man/metadata.Rd index 779824c68..3a59729db 100644 --- a/man/metadata.Rd +++ b/man/metadata.Rd @@ -62,104 +62,48 @@ Metadata cache summary: \if{html}{\out{
}}\preformatted{meta_summary() #> $cachepath -#> [1] "/Users/gaborcsardi/Library/Caches/org.R-project.R/R/pkgcache/_metadata" +#> [1] "/home/runner/.cache/R/pkgcache/_metadata" #> #> $current_db -#> [1] "/Users/gaborcsardi/Library/Caches/org.R-project.R/R/pkgcache/_metadata/pkgs-34444e3072.rds" +#> [1] "/home/runner/.cache/R/pkgcache/_metadata/pkgs-c22cd3b850.rds" #> #> $raw_files -#> [1] "/Users/gaborcsardi/Library/Caches/org.R-project.R/R/pkgcache/_metadata/BioCann-59693086a0/bin/macosx/big-sur-arm64/contrib/4.2/PACKAGES.gz" -#> [2] "/Users/gaborcsardi/Library/Caches/org.R-project.R/R/pkgcache/_metadata/BioCann-59693086a0/src/contrib/PACKAGES.gz" -#> [3] "/Users/gaborcsardi/Library/Caches/org.R-project.R/R/pkgcache/_metadata/BioCexp-90d4a3978b/bin/macosx/big-sur-arm64/contrib/4.2/PACKAGES.gz" -#> [4] "/Users/gaborcsardi/Library/Caches/org.R-project.R/R/pkgcache/_metadata/BioCexp-90d4a3978b/src/contrib/PACKAGES.gz" -#> [5] "/Users/gaborcsardi/Library/Caches/org.R-project.R/R/pkgcache/_metadata/BioCsoft-2a43920999/bin/macosx/big-sur-arm64/contrib/4.2/PACKAGES.gz" -#> [6] "/Users/gaborcsardi/Library/Caches/org.R-project.R/R/pkgcache/_metadata/BioCsoft-2a43920999/src/contrib/PACKAGES.gz" -#> [7] "/Users/gaborcsardi/Library/Caches/org.R-project.R/R/pkgcache/_metadata/BioCworkflows-26330ba3ca/bin/macosx/big-sur-arm64/contrib/4.2/PACKAGES.gz" -#> [8] "/Users/gaborcsardi/Library/Caches/org.R-project.R/R/pkgcache/_metadata/BioCworkflows-26330ba3ca/src/contrib/PACKAGES.gz" -#> [9] "/Users/gaborcsardi/Library/Caches/org.R-project.R/R/pkgcache/_metadata/CRAN-075c426938/bin/macosx/big-sur-arm64/contrib/4.2/PACKAGES.gz" -#> [10] "/Users/gaborcsardi/Library/Caches/org.R-project.R/R/pkgcache/_metadata/CRAN-075c426938/src/contrib/PACKAGES.gz" +#> [1] "/home/runner/.cache/R/pkgcache/_metadata/BioCann-133378caf4/src/contrib/PACKAGES.gz" +#> [2] "/home/runner/.cache/R/pkgcache/_metadata/BioCbooks-acae71babc/src/contrib/PACKAGES.gz" +#> [3] "/home/runner/.cache/R/pkgcache/_metadata/BioCexp-9d0a1dae1d/src/contrib/PACKAGES.gz" +#> [4] "/home/runner/.cache/R/pkgcache/_metadata/BioCsoft-41b228b7fc/src/contrib/PACKAGES.gz" +#> [5] "/home/runner/.cache/R/pkgcache/_metadata/BioCworkflows-6b25871327/src/contrib/PACKAGES.gz" +#> [6] "/home/runner/.cache/R/pkgcache/_metadata/CRAN-075c426938/src/contrib/PACKAGES.gz" +#> [7] "/home/runner/.cache/R/pkgcache/_metadata/RSPM-49260a4dff/src/contrib/PACKAGES.gz" #> #> $db_files -#> [1] "/Users/gaborcsardi/Library/Caches/org.R-project.R/R/pkgcache/_metadata/pkgs-34444e3072.rds" -#> [2] "/Users/gaborcsardi/Library/Caches/org.R-project.R/R/pkgcache/_metadata/pkgs-ccacf1b389.rds" +#> [1] "/home/runner/.cache/R/pkgcache/_metadata/pkgs-c22cd3b850.rds" #> #> $size -#> [1] 174848200 +#> [1] 111564643 }\if{html}{\out{
}} The current metadata DB: -\if{html}{\out{
}}\preformatted{meta_list() -}\if{html}{\out{
}}\if{html}{\out{ -
-#>  Loading metadata database ... done                                    
-#> # A data frame: 45,279 × 32                                             
-#>    package version depends sugge…¹ license imports linki…² archs enhan…³
-#>    <chr>   <chr>   <chr>   <chr>   <chr>   <chr>   <chr>   <chr> <chr>  
-#>  1 A3      1.0.0   R (>= … random… GPL (>… NA      NA      NA    NA     
-#>  2 AATtoo… 0.0.2   R (>= … NA      GPL-3   magrit… NA      NA    NA     
-#>  3 ABACUS  1.0.0   R (>= … rmarkd… GPL-3   ggplot… NA      NA    NA     
-#>  4 ABC.RAP 0.9.0   R (>= … knitr,… GPL-3   graphi… NA      NA    NA     
-#>  5 ABCana… 1.2.1   R (>= … NA      GPL-3   plotrix NA      NA    NA     
-#>  6 ABCopt… 0.15.0  NA      testth… MIT + … Rcpp, … Rcpp    ABCo… NA     
-#>  7 ABCp2   1.2     MASS    NA      GPL-2   NA      NA      NA    NA     
-#>  8 ABHgen… 1.0.1   NA      knitr,… GPL-3   ggplot… NA      NA    NA     
-#>  9 ABPS    0.3     NA      testth… GPL (>… kernlab NA      NA    NA     
-#> 10 ACA     1.1     R (>= … NA      GPL     graphi… NA      NA    NA     
-#> # … with 45,269 more rows, 23 more variables:                           
-#> #   license_restricts_use <chr>, os_type <chr>, priority <chr>,         
-#> #   license_is_foss <chr>, repodir <chr>, rversion <chr>,               
-#> #   platform <chr>, needscompilation <chr>, ref <chr>, type <chr>,      
-#> #   direct <lgl>, status <chr>, target <chr>, mirror <chr>,             
-#> #   sources <list>, filesize <int>, sha256 <chr>, sysreqs <chr>,        
-#> #   built <chr>, published <dttm>, deps <list>, md5sum <chr>, …         
-
-}} - +\if{html}{\out{
}}\preformatted{meta_list() +}\if{html}{\out{
}} Selected packages only: -\if{html}{\out{
}}\preformatted{meta_list(pkg = c("shiny", "htmlwidgets")) -}\if{html}{\out{
}}\if{html}{\out{ -
-#>   package  version depends sugge…¹ license imports linki…² archs enhan…³
-#> * <chr>    <chr>   <chr>   <chr>   <chr>   <chr>   <chr>   <chr> <chr>  
-#> 1 htmlwid… 1.5.4   NA      "knitr… MIT + … "grDev… NA      NA    shiny …
-#> 2 shiny    1.7.3   R (>= … "datas… GPL-3 … "utils… NA      NA    NA     
-#> 3 htmlwid… 1.6.0   NA      "testt… MIT + … "grDev… NA      NA    shiny …
-#> 4 shiny    1.7.4   R (>= … "datas… GPL-3 … "utils… NA      NA    NA     
-#> # … with 23 more variables: license_restricts_use <chr>, os_type <chr>, 
-#> #   priority <chr>, license_is_foss <chr>, repodir <chr>,               
-#> #   rversion <chr>, platform <chr>, needscompilation <chr>, ref <chr>,  
-#> #   type <chr>, direct <lgl>, status <chr>, target <chr>, mirror <chr>, 
-#> #   sources <list>, filesize <int>, sha256 <chr>, sysreqs <chr>,        
-#> #   built <chr>, published <dttm>, deps <list>, md5sum <chr>,           
-#> #   path <chr>, and abbreviated variable names ¹​suggests, ²​linkingto, 
-#>                                                                        
-
-}} +\if{html}{\out{
}}\preformatted{meta_list(pkg = c("shiny", "htmlwidgets")) +}\if{html}{\out{
}} Update the metadata DB -\if{html}{\out{
}}\preformatted{meta_update() -}\if{html}{\out{
}}\if{html}{\out{ -
-#>  Updated metadata database: 1.23 MB in 1 file.                         
-#>  Updating metadata database ... done                                   
-
-}} +\if{html}{\out{
}}\preformatted{meta_update() +}\if{html}{\out{
}} Delete the metadata DB -\if{html}{\out{
}}\preformatted{meta_clean() -}\if{html}{\out{
}}\if{html}{\out{ -
-#>  Cleaning up cache directory /Users/gaborcsardi/Library/Caches/org.R-pr
-#> oject.R/R/pkgcache/_metadata.                                           
-
-}} +\if{html}{\out{
}}\preformatted{meta_clean() +}\if{html}{\out{
}} } diff --git a/man/pak_sitrep.Rd b/man/pak_sitrep.Rd index 933f9c94e..27977c597 100644 --- a/man/pak_sitrep.Rd +++ b/man/pak_sitrep.Rd @@ -20,27 +20,8 @@ It prints \section{Examples}{ -\if{html}{\out{
}}\preformatted{pak_sitrep() -}\if{html}{\out{
}}\if{html}{\out{ -
-#>  compatible)                                                            
-#> - pak repository: - (local install?)                                    
-#> * Optional packages installed:                                          
-#> - pillar                                                                
-#> * Library path:                                                         
-#> - /private/var/folders/ph/fpcmzfd16rgbbk8mxvy9m2_h0000gn/T/RtmpcpVAdU/fi
-#> led8ef3d7a46fc                                                          
-#> - /private/var/folders/ph/fpcmzfd16rgbbk8mxvy9m2_h0000gn/T/RtmpcpVAdU/fi
-#> led8ef2562d6ef                                                          
-#> - /Users/gaborcsardi/Library/R/arm64/4.2/library                        
-#> - /Library/Frameworks/R.framework/Versions/4.2-arm64/Resources/library  
-#> * Private library location:                                             
-#> - /Users/gaborcsardi/Library/Caches/org.R-project.R/R/pak/lib/4.2/aarch6
-#> 4                                                                       
-#> * Private library exists.                                               
-#> * Private library is functional                                         
-
-}} +\if{html}{\out{
}}\preformatted{pak_sitrep() +}\if{html}{\out{
}} } \seealso{ diff --git a/man/pkg_deps.Rd b/man/pkg_deps.Rd index 8ea02a005..be82143cb 100644 --- a/man/pkg_deps.Rd +++ b/man/pkg_deps.Rd @@ -9,12 +9,12 @@ pkg_deps(pkg, upgrade = TRUE, dependencies = NA) \arguments{ \item{pkg}{Package names or package references. E.g. \itemize{ -\item \code{ggplot2}: package from CRAN, Bioconductor or a CRAN-like repository +\item \code{ggplot2} or \code{cran::ggplot2}: package from CRAN, Bioconductor or a CRAN-like repository in general, -\item \code{tidyverse/ggplot2}: package from GitHub, -\item \code{tidyverse/ggplot2@v3.4.0}: package from GitHub tag or branch, -\item \verb{https://examples.com/.../ggplot2_3.3.6.tar.gz}: package from URL, -\item \code{.}: package in the current working directory. +\item \code{tidyverse/ggplot2} or \code{github::tidyverse/ggplot2}: package from GitHub, +\item \code{tidyverse/ggplot2@v3.4.0} or \code{github::tidyverse/ggplot2@v3.4.0}: package from GitHub tag or branch, +\item \verb{url::https://examples.com/.../ggplot2_3.3.6.tar.gz}: package from URL, +\item \code{.} or \code{local::.}: package in the current working directory. } See "\link{Package sources}" for more details.} @@ -45,60 +45,13 @@ Look up the dependencies of a package \section{Examples}{ -\if{html}{\out{
}}\preformatted{pkg_deps("dplyr") -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 16 × 32                                                 
-#>    ref       type  direct direc…¹ status package version license needs…²
-#>    <chr>     <chr> <lgl>  <lgl>   <chr>  <chr>   <chr>   <chr>   <lgl>  
-#>  1 R6        stan… FALSE  FALSE   OK     R6      2.5.1   MIT + … FALSE  
-#>  2 cli       stan… FALSE  FALSE   OK     cli     3.4.1   MIT + … FALSE  
-#>  3 dplyr     stan… TRUE   TRUE    OK     dplyr   1.0.10  MIT + … FALSE  
-#>  4 fansi     stan… FALSE  FALSE   OK     fansi   1.0.3   GPL-2 … FALSE  
-#>  5 generics  stan… FALSE  FALSE   OK     generi… 0.1.3   MIT + … FALSE  
-#>  6 glue      stan… FALSE  FALSE   OK     glue    1.6.2   MIT + … FALSE  
-#>  7 lifecycle stan… FALSE  FALSE   OK     lifecy… 1.0.3   MIT + … FALSE  
-#>  8 magrittr  stan… FALSE  FALSE   OK     magrit… 2.0.3   MIT + … FALSE  
-#>  9 pillar    stan… FALSE  FALSE   OK     pillar  1.8.1   MIT + … FALSE  
-#> 10 pkgconfig stan… FALSE  FALSE   OK     pkgcon… 2.0.3   MIT + … FALSE  
-#> 11 rlang     stan… FALSE  FALSE   OK     rlang   1.0.6   MIT + … FALSE  
-#> 12 tibble    stan… FALSE  FALSE   OK     tibble  3.1.8   MIT + … FALSE  
-#> 13 tidysele… stan… FALSE  FALSE   OK     tidyse… 1.2.0   MIT + … FALSE  
-#> 14 utf8      stan… FALSE  FALSE   OK     utf8    1.2.2   Apache… FALSE  
-#> 15 vctrs     stan… FALSE  FALSE   OK     vctrs   0.5.1   MIT + … FALSE  
-#> 16 withr     stan… FALSE  FALSE   OK     withr   2.5.0   MIT + … FALSE  
-#> # … with 23 more variables: priority <chr>, md5sum <chr>, sha256 <chr>, 
-#> #   filesize <int>, built <chr>, platform <chr>, rversion <chr>,        
-#> #   repotype <chr>, repodir <chr>, target <chr>, deps <list>,           
-#> #   mirror <chr>, sources <list>, remote <list>, error <list>,          
-#> #   metadata <list>, dep_types <list>, params <list>, sysreqs <chr>,    
-#> #   cache_status <chr>, lib_status <chr>, old_version <chr>,            
-#> #   new_version <chr>, and abbreviated variable names ¹​directpkg, …    
-
-}} - +\if{html}{\out{
}}\preformatted{pkg_deps("dplyr") +}\if{html}{\out{
}} For a package on GitHub: -\if{html}{\out{
}}\preformatted{pkg_deps("r-lib/callr") -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 4 × 32                                                  
-#>   ref        type  direct direc…¹ status package version license needs…²
-#>   <chr>      <chr> <lgl>  <lgl>   <chr>  <chr>   <chr>   <chr>   <lgl>  
-#> 1 r-lib/cal… gith… TRUE   TRUE    OK     callr   3.7.3.… MIT + … TRUE   
-#> 2 R6         stan… FALSE  FALSE   OK     R6      2.5.1   MIT + … FALSE  
-#> 3 processx   stan… FALSE  FALSE   OK     proces… 3.8.0   MIT + … FALSE  
-#> 4 ps         stan… FALSE  FALSE   OK     ps      1.7.2   MIT + … FALSE  
-#> # … with 23 more variables: priority <chr>, md5sum <chr>, sha256 <chr>, 
-#> #   filesize <int>, built <chr>, platform <chr>, rversion <chr>,        
-#> #   repotype <chr>, repodir <chr>, target <chr>, deps <list>,           
-#> #   mirror <chr>, sources <list>, remote <list>, error <list>,          
-#> #   metadata <list>, dep_types <list>, params <list>, sysreqs <chr>,    
-#> #   cache_status <chr>, lib_status <chr>, old_version <chr>,            
-#> #   new_version <chr>, and abbreviated variable names ¹​directpkg, …    
-
-}} +\if{html}{\out{
}}\preformatted{pkg_deps("r-lib/callr") +}\if{html}{\out{
}} } \seealso{ diff --git a/man/pkg_deps_explain.Rd b/man/pkg_deps_explain.Rd index 0c6844a99..bea275f6a 100644 --- a/man/pkg_deps_explain.Rd +++ b/man/pkg_deps_explain.Rd @@ -9,12 +9,12 @@ pkg_deps_explain(pkg, deps, upgrade = TRUE, dependencies = NA) \arguments{ \item{pkg}{Package names or package references. E.g. \itemize{ -\item \code{ggplot2}: package from CRAN, Bioconductor or a CRAN-like repository +\item \code{ggplot2} or \code{cran::ggplot2}: package from CRAN, Bioconductor or a CRAN-like repository in general, -\item \code{tidyverse/ggplot2}: package from GitHub, -\item \code{tidyverse/ggplot2@v3.4.0}: package from GitHub tag or branch, -\item \verb{https://examples.com/.../ggplot2_3.3.6.tar.gz}: package from URL, -\item \code{.}: package in the current working directory. +\item \code{tidyverse/ggplot2} or \code{github::tidyverse/ggplot2}: package from GitHub, +\item \code{tidyverse/ggplot2@v3.4.0} or \code{github::tidyverse/ggplot2@v3.4.0}: package from GitHub tag or branch, +\item \verb{url::https://examples.com/.../ggplot2_3.3.6.tar.gz}: package from URL, +\item \code{.} or \code{local::.}: package in the current working directory. } See "\link{Package sources}" for more details.} @@ -53,47 +53,12 @@ to read if you are only interested is certain packages (\code{deps}). How does dplyr depend on rlang? -\if{html}{\out{
}}\preformatted{pkg_deps_explain("dplyr", "rlang") -}\if{html}{\out{
}}\if{html}{\out{ -
-#>  Updated metadata database: 5.09 MB in 12 files.                       
-#>  Updating metadata database ... done                                   
-#> dplyr -> lifecycle -> rlang                                             
-#> dplyr -> rlang                                                          
-#> dplyr -> tibble -> lifecycle -> rlang                                   
-#> dplyr -> tibble -> pillar -> lifecycle -> rlang                         
-#> dplyr -> tibble -> pillar -> rlang                                      
-#> dplyr -> tibble -> pillar -> vctrs -> lifecycle -> rlang                
-#> dplyr -> tibble -> pillar -> vctrs -> rlang                             
-#> dplyr -> tibble -> rlang                                                
-#> dplyr -> tibble -> vctrs -> lifecycle -> rlang                          
-#> dplyr -> tibble -> vctrs -> rlang                                       
-#> dplyr -> tidyselect -> lifecycle -> rlang                               
-#> dplyr -> tidyselect -> rlang                                            
-#> dplyr -> tidyselect -> vctrs -> lifecycle -> rlang                      
-#> dplyr -> tidyselect -> vctrs -> rlang                                   
-#> dplyr -> vctrs -> lifecycle -> rlang                                    
-#> dplyr -> vctrs -> rlang                                                 
-#> dplyr -> pillar -> lifecycle -> rlang                                   
-#> dplyr -> pillar -> rlang                                                
-#> dplyr -> pillar -> vctrs -> lifecycle -> rlang                          
-#> dplyr -> pillar -> vctrs -> rlang                                       
-
-}} - +\if{html}{\out{
}}\preformatted{pkg_deps_explain("dplyr", "rlang") +}\if{html}{\out{
}} How does the GH version of usethis depend on cli and ps? -\if{html}{\out{
}}\preformatted{pkg_deps_explain("r-lib/usethis", c("cli", "ps")) -}\if{html}{\out{
}}\if{html}{\out{ -
-#> usethis -> cli                                                          
-#> usethis -> desc -> cli                                                  
-#> usethis -> gh -> cli                                                    
-#> usethis -> lifecycle -> cli                                             
-#>                                                                         
-#> x ps                                                                    
-
-}} +\if{html}{\out{
}}\preformatted{pkg_deps_explain("r-lib/usethis", c("cli", "ps")) +}\if{html}{\out{
}} } diff --git a/man/pkg_deps_tree.Rd b/man/pkg_deps_tree.Rd index 467b6281a..d246ecf02 100644 --- a/man/pkg_deps_tree.Rd +++ b/man/pkg_deps_tree.Rd @@ -9,12 +9,12 @@ pkg_deps_tree(pkg, upgrade = TRUE, dependencies = NA) \arguments{ \item{pkg}{Package names or package references. E.g. \itemize{ -\item \code{ggplot2}: package from CRAN, Bioconductor or a CRAN-like repository +\item \code{ggplot2} or \code{cran::ggplot2}: package from CRAN, Bioconductor or a CRAN-like repository in general, -\item \code{tidyverse/ggplot2}: package from GitHub, -\item \code{tidyverse/ggplot2@v3.4.0}: package from GitHub tag or branch, -\item \verb{https://examples.com/.../ggplot2_3.3.6.tar.gz}: package from URL, -\item \code{.}: package in the current working directory. +\item \code{tidyverse/ggplot2} or \code{github::tidyverse/ggplot2}: package from GitHub, +\item \code{tidyverse/ggplot2@v3.4.0} or \code{github::tidyverse/ggplot2@v3.4.0}: package from GitHub tag or branch, +\item \verb{url::https://examples.com/.../ggplot2_3.3.6.tar.gz}: package from URL, +\item \code{.} or \code{local::.}: package in the current working directory. } See "\link{Package sources}" for more details.} @@ -43,111 +43,11 @@ Draw the dependency tree of a package \section{Examples}{ -\if{html}{\out{
}}\preformatted{pkg_deps_tree("dplyr") -}\if{html}{\out{
}}\if{html}{\out{ -
-#> dplyr 1.0.10                                                           
-#> ├─generics 0.1.3                                                       
-#> ├─glue 1.6.2                                                           
-#> ├─lifecycle 1.0.3                                                      
-#> │ ├─cli 3.4.1                                                          
-#> │ ├─glue                                                                
-#> │ └─rlang 1.0.6                                                        
-#> ├─magrittr 2.0.3                                                       
-#> ├─R6 2.5.1                                                             
-#> ├─rlang                                                                 
-#> ├─tibble 3.1.8                                                         
-#> │ ├─fansi 1.0.3                                                        
-#> │ ├─lifecycle                                                           
-#> │ ├─magrittr                                                            
-#> │ ├─pillar 1.8.1                                                       
-#> │ │ ├─cli                                                               
-#> │ │ ├─fansi                                                             
-#> │ │ ├─glue                                                              
-#> │ │ ├─lifecycle                                                         
-#> │ │ ├─rlang                                                             
-#> │ │ ├─utf8 1.2.2                                                       
-#> │ │ └─vctrs 0.5.1                                                      
-#> │ │   ├─cli                                                             
-#> │ │   ├─glue                                                            
-#> │ │   ├─lifecycle                                                       
-#> │ │   └─rlang                                                           
-#> │ ├─pkgconfig 2.0.3                                                    
-#> │ ├─rlang                                                               
-#> │ └─vctrs                                                               
-#> ├─tidyselect 1.2.0                                                     
-#> │ ├─cli                                                                 
-#> │ ├─glue                                                                
-#> │ ├─lifecycle                                                           
-#> │ ├─rlang                                                               
-#> │ ├─vctrs                                                               
-#> │ └─withr 2.5.0                                                        
-#> ├─vctrs                                                                 
-#> └─pillar                                                                
-#>                                                                         
-#> Key:   new                                                             
-
-}} - +\if{html}{\out{
}}\preformatted{pkg_deps_tree("dplyr") +}\if{html}{\out{
}} -\if{html}{\out{
}}\preformatted{pkg_deps_tree("r-lib/usethis") -}\if{html}{\out{
}}\if{html}{\out{ -
-#> r-lib/usethis 2.1.6.9000 ✨👷🏼🔧                                           
-#> ├─cli 3.4.1                                                            
-#> ├─clipr 0.8.0                                                          
-#> ├─crayon 1.5.2                                                         
-#> ├─curl 4.3.3                                                           
-#> ├─desc 1.4.2                                                           
-#> │ ├─cli                                                                 
-#> │ ├─R6 2.5.1                                                           
-#> │ └─rprojroot 2.0.3                                                    
-#> ├─fs 1.5.2                                                             
-#> ├─gert 1.9.2 ✨ ⬇ (1.91 MB)                                              
-#> │ ├─askpass 1.1                                                        
-#> │ │ └─sys 3.4.1                                                        
-#> │ ├─credentials 1.3.2 ✨ ⬇ (170.15 kB)                                   
-#> │ │ ├─openssl 2.0.5                                                    
-#> │ │ │ └─askpass                                                         
-#> │ │ ├─sys                                                               
-#> │ │ ├─curl                                                              
-#> │ │ ├─jsonlite 1.8.4                                                   
-#> │ │ └─askpass                                                           
-#> │ ├─openssl                                                             
-#> │ ├─rstudioapi 0.14                                                    
-#> │ ├─sys                                                                 
-#> │ └─zip 2.2.2                                                          
-#> ├─gh 1.3.1 ✨ ⬇ (95.20 kB)                                               
-#> │ ├─cli                                                                 
-#> │ ├─gitcreds 0.1.2 ✨ ⬇ (95.59 kB)                                       
-#> │ ├─httr 1.4.4                                                         
-#> │ │ ├─curl                                                              
-#> │ │ ├─jsonlite                                                          
-#> │ │ ├─mime 0.12                                                        
-#> │ │ ├─openssl                                                           
-#> │ │ └─R6                                                                
-#> │ ├─ini 0.3.1 ✨ ⬇ (13.13 kB)                                            
-#> │ └─jsonlite                                                            
-#> ├─glue 1.6.2                                                           
-#> ├─jsonlite                                                              
-#> ├─lifecycle 1.0.3                                                      
-#> │ ├─cli                                                                 
-#> │ ├─glue                                                                
-#> │ └─rlang 1.0.6                                                        
-#> ├─purrr 0.3.5                                                          
-#> │ ├─magrittr 2.0.3                                                     
-#> │ └─rlang                                                               
-#> ├─rappdirs 0.3.3                                                       
-#> ├─rlang                                                                 
-#> ├─rprojroot                                                             
-#> ├─rstudioapi                                                            
-#> ├─whisker 0.4.1 ✨ ⬇ (65.36 kB)                                          
-#> ├─withr 2.5.0                                                          
-#> └─yaml 2.3.6                                                           
-#>                                                                         
-#> Key:   new |  download | 👷🏼 build | 🔧 compile                        
-
-}} +\if{html}{\out{
}}\preformatted{pkg_deps_tree("r-lib/usethis") +}\if{html}{\out{
}} } \seealso{ diff --git a/man/pkg_download.Rd b/man/pkg_download.Rd index eb9bbfd80..81afb311f 100644 --- a/man/pkg_download.Rd +++ b/man/pkg_download.Rd @@ -15,12 +15,12 @@ pkg_download( \arguments{ \item{pkg}{Package names or package references. E.g. \itemize{ -\item \code{ggplot2}: package from CRAN, Bioconductor or a CRAN-like repository +\item \code{ggplot2} or \code{cran::ggplot2}: package from CRAN, Bioconductor or a CRAN-like repository in general, -\item \code{tidyverse/ggplot2}: package from GitHub, -\item \code{tidyverse/ggplot2@v3.4.0}: package from GitHub tag or branch, -\item \verb{https://examples.com/.../ggplot2_3.3.6.tar.gz}: package from URL, -\item \code{.}: package in the current working directory. +\item \code{tidyverse/ggplot2} or \code{github::tidyverse/ggplot2}: package from GitHub, +\item \code{tidyverse/ggplot2@v3.4.0} or \code{github::tidyverse/ggplot2@v3.4.0}: package from GitHub tag or branch, +\item \verb{url::https://examples.com/.../ggplot2_3.3.6.tar.gz}: package from URL, +\item \code{.} or \code{local::.}: package in the current working directory. } See "\link{Package sources}" for more details.} @@ -58,48 +58,17 @@ TODO: explain result \section{Examples}{ -\if{html}{\out{
}}\preformatted{dl <- pkg_download("forcats") -}\if{html}{\out{
}}\if{html}{\out{ -
-#>  No downloads are needed, 2 pkgs (641.53 kB) are cached                
-
-}} - +\if{html}{\out{
}}\preformatted{dl <- pkg_download("forcats") +}\if{html}{\out{
}} -\if{html}{\out{
}}\preformatted{dl -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 2 × 35                                                  
-#>   ref     type     direct direc…¹ status package version license needs…²
-#>   <chr>   <chr>    <lgl>  <lgl>   <chr>  <chr>   <chr>   <chr>   <lgl>  
-#> 1 forcats standard TRUE   TRUE    OK     forcats 0.5.2   MIT + … FALSE  
-#> 2 forcats standard TRUE   TRUE    OK     forcats 0.5.2   MIT + … FALSE  
-#> # … with 26 more variables: priority <chr>, md5sum <chr>, sha256 <chr>, 
-#> #   filesize <int>, built <chr>, platform <chr>, rversion <chr>,        
-#> #   repotype <chr>, repodir <chr>, target <chr>, deps <list>,           
-#> #   mirror <chr>, sources <list>, remote <list>, error <list>,          
-#> #   metadata <list>, extra <list>, dep_types <list>, params <list>,     
-#> #   sysreqs <chr>, cache_status <chr>, fulltarget <chr>,                
-#> #   fulltarget_tree <chr>, download_status <chr>, …                     
-
-}} +\if{html}{\out{
}}\preformatted{dl +}\if{html}{\out{
}} +\if{html}{\out{
}}\preformatted{dl$fulltarget +}\if{html}{\out{
}} -\if{html}{\out{
}}\preformatted{dl$fulltarget -}\if{html}{\out{
}}\if{html}{\out{ -
-#> [1] "./bin/macosx/big-sur-arm64/contrib/4.2/forcats_0.5.2.tgz"          
-#> [2] "./src/contrib/forcats_0.5.2.tar.gz"                                
-
-}} - - -\if{html}{\out{
}}\preformatted{pkg_download("r-lib/pak", platforms = "source") -}\if{html}{\out{
}}\if{html}{\out{ -
-#>  No downloads are needed, 1 pkg is cached                              
-
-}} +\if{html}{\out{
}}\preformatted{pkg_download("r-lib/pak", platforms = "source") +}\if{html}{\out{
}} } \seealso{ diff --git a/man/pkg_history.Rd b/man/pkg_history.Rd index 902d269ac..0a200049a 100644 --- a/man/pkg_history.Rd +++ b/man/pkg_history.Rd @@ -20,30 +20,7 @@ Query the history of a CRAN package \section{Examples}{ -\if{html}{\out{
}}\preformatted{pkg_history("ggplot2") -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 44 × 30                                                 
-#>    Package Type    Title    Version Date  Author Maint…¹ Descr…² License
-#>  * <chr>   <chr>   <chr>    <chr>   <chr> <chr>  <chr>   <chr>   <chr>  
-#>  1 ggplot2 Package An impl… 0.5     2007… Hadle… Hadley… "An im… GPL    
-#>  2 ggplot2 Package An impl… 0.5.1   2007… Hadle… Hadley… "An im… GPL    
-#>  3 ggplot2 Package An impl… 0.5.2   2007… Hadle… Hadley… "An im… GPL    
-#>  4 ggplot2 Package An impl… 0.5.4   2007… Hadle… Hadley… "An im… GPL    
-#>  5 ggplot2 Package An impl… 0.5.5   2007… Hadle… Hadley… "An im… GPL    
-#>  6 ggplot2 Package An impl… 0.5.6   2007… Hadle… Hadley… "An im… GPL    
-#>  7 ggplot2 Package An impl… 0.5.7   2007… Hadle… Hadley… "An im… GPL    
-#>  8 ggplot2 Package An impl… 0.6     2008… Hadle… Hadley… "An im… GPL    
-#>  9 ggplot2 Package An impl… 0.7     2008… Hadle… Hadley… "An im… GPL    
-#> 10 ggplot2 Package An impl… 0.8     2008… Hadle… Hadley… "An im… GPL    
-#> # … with 34 more rows, 21 more variables: SaveImage <chr>,              
-#> #   LazyData <chr>, Packaged <chr>, crandb_file_date <chr>, date <chr>, 
-#> #   dependencies <list>, URL <chr>, LazyLoad <chr>, Extends <chr>,      
-#> #   Collate <chr>, Repository <chr>, `Date/Publication` <chr>,          
-#> #   NeedsCompilation <chr>, VignetteBuilder <chr>, BugReports <chr>,    
-#> #   `Authors@R` <chr>, RoxygenNote <chr>, Encoding <chr>, MD5sum <chr>, 
-#> #   `Config/Needs/website` <chr>, `Config/testthat/edition` <chr>, …    
-
-}} +\if{html}{\out{
}}\preformatted{pkg_history("ggplot2") +}\if{html}{\out{
}} } diff --git a/man/pkg_install.Rd b/man/pkg_install.Rd index ae1df2527..f1d1cf44b 100644 --- a/man/pkg_install.Rd +++ b/man/pkg_install.Rd @@ -15,12 +15,12 @@ pkg_install( \arguments{ \item{pkg}{Package names or package references. E.g. \itemize{ -\item \code{ggplot2}: package from CRAN, Bioconductor or a CRAN-like repository +\item \code{ggplot2} or \code{cran::ggplot2}: package from CRAN, Bioconductor or a CRAN-like repository in general, -\item \code{tidyverse/ggplot2}: package from GitHub, -\item \code{tidyverse/ggplot2@v3.4.0}: package from GitHub tag or branch, -\item \verb{https://examples.com/.../ggplot2_3.3.6.tar.gz}: package from URL, -\item \code{.}: package in the current working directory. +\item \code{tidyverse/ggplot2} or \code{github::tidyverse/ggplot2}: package from GitHub, +\item \code{tidyverse/ggplot2@v3.4.0} or \code{github::tidyverse/ggplot2@v3.4.0}: package from GitHub tag or branch, +\item \verb{url::https://examples.com/.../ggplot2_3.3.6.tar.gz}: package from URL, +\item \code{.} or \code{local::.}: package in the current working directory. } See "\link{Package sources}" for more details.} @@ -69,145 +69,24 @@ package library. \section{Examples}{ -\if{html}{\out{
}}\preformatted{pkg_install("dplyr") -}\if{html}{\out{
}}\if{html}{\out{ -
-#>                                                                         
-#> → Will install 5 packages.                                              
-#> → All 5 packages (2.14 MB) are cached.                                  
-#> + dplyr        1.0.9                                                    
-#> + generics     0.1.2                                                    
-#> + purrr        0.3.4                                                    
-#> + R6           2.5.1                                                    
-#> + tidyselect   1.1.2                                                    
-#>  No downloads are needed, 5 pkgs (2.14 MB) are cached                  
-#>  Got R6 2.5.1 (aarch64-apple-darwin20) (82.52 kB)                      
-#>  Installed R6 2.5.1  (43ms)                                            
-#>  Installed generics 0.1.2  (62ms)                                      
-#>  Installed dplyr 1.0.9  (88ms)                                         
-#>  Installed purrr 0.3.4  (88ms)                                         
-#>  Installed tidyselect 1.1.2  (94ms)                                    
-#>  1 pkg + 17 deps: kept 12, added 5, dld 1 (82.52 kB) [1.2s]            
-
-}} - +\if{html}{\out{
}}\preformatted{pkg_install("dplyr") +}\if{html}{\out{
}} Upgrade dplyr and all its dependencies: -\if{html}{\out{
}}\preformatted{pkg_install("dplyr", upgrade = TRUE) -}\if{html}{\out{
}}\if{html}{\out{ -
-#>                                                                         
-#> → Will update 1 package.                                                
-#> → The package (742.51 kB) is cached.                                    
-#> + rlang 1.0.2 → 1.0.3 👷🏿‍♀️🔧                                            
-#>  No downloads are needed, 1 pkg (742.51 kB) is cached                  
-#>  Building rlang 1.0.3                                                  
-#>  Built rlang 1.0.3 (5.8s)                                              
-#>  Installed rlang 1.0.3  (32ms)                                         
-#>  1 pkg + 17 deps: kept 17, upd 1 [6.3s]                                
-
-}} - +\if{html}{\out{
}}\preformatted{pkg_install("dplyr", upgrade = TRUE) +}\if{html}{\out{
}} Install the development version of dplyr: -\if{html}{\out{
}}\preformatted{pkg_install("tidyverse/dplyr") -}\if{html}{\out{
}}\if{html}{\out{ -
-#>  Loading metadata database ... done                                    
-#>                                                                         
-#> → Will install 16 packages.                                             
-#> → All 16 packages (8.09 MB) are cached.                                 
-#> + cli          3.4.1                                                    
-#> + dplyr        1.0.99.9000 👷🏾‍♂️🔧 (GitHub: e6252f8)                     
-#> + fansi        1.0.3                                                    
-#> + generics     0.1.3                                                    
-#> + glue         1.6.2                                                    
-#> + lifecycle    1.0.3                                                    
-#> + magrittr     2.0.3                                                    
-#> + pillar       1.8.1                                                    
-#> + pkgconfig    2.0.3                                                    
-#> + R6           2.5.1                                                    
-#> + rlang        1.0.6                                                    
-#> + tibble       3.1.8                                                    
-#> + tidyselect   1.2.0                                                    
-#> + utf8         1.2.2                                                    
-#> + vctrs        0.5.1                                                    
-#> + withr        2.5.0                                                    
-#>  No downloads are needed, 16 pkgs (8.09 MB) are cached                 
-#>  Installed R6 2.5.1  (58ms)                                            
-#>  Installed cli 3.4.1  (69ms)                                           
-#>  Installed fansi 1.0.3  (92ms)                                         
-#>  Installed generics 0.1.3  (99ms)                                      
-#>  Installed glue 1.6.2  (108ms)                                         
-#>  Installed lifecycle 1.0.3  (144ms)                                    
-#>  Installed magrittr 2.0.3  (152ms)                                     
-#>  Installed pillar 1.8.1  (160ms)                                       
-#>  Installed pkgconfig 2.0.3  (63ms)                                     
-#>  Installed rlang 1.0.6  (37ms)                                         
-#>  Installed tibble 3.1.8  (41ms)                                        
-#>  Installed tidyselect 1.2.0  (38ms)                                    
-#>  Installed utf8 1.2.2  (36ms)                                          
-#>  Installed vctrs 0.5.1  (39ms)                                         
-#>  Installed withr 2.5.0  (30ms)                                         
-#>  Packaging dplyr 1.0.99.9000                                           
-#>  Packaged dplyr 1.0.99.9000 (8.3s)                                     
-#>  Building dplyr 1.0.99.9000                                            
-#>  Built dplyr 1.0.99.9000 (5.2s)                                        
-#>  Installed dplyr 1.0.99.9000 (github::tidyverse/dplyr@e6252f8) (24ms)  
-#>  1 pkg + 15 deps: added 16 [18.9s]                                     
-
-}} - +\if{html}{\out{
}}\preformatted{pkg_install("tidyverse/dplyr") +}\if{html}{\out{
}} Switch back to the CRAN version. This will be fast because pak will have cached the prior install. -\if{html}{\out{
}}\preformatted{pkg_install("dplyr") -}\if{html}{\out{
}}\if{html}{\out{ -
-#>  Updated metadata database: 2.43 MB in 6 files.                        
-#>  Updating metadata database ... done                                   
-#>                                                                         
-#> → Will install 16 packages.                                             
-#> → All 16 packages (9.42 MB) are cached.                                 
-#> + cli          3.4.1                                                    
-#> + dplyr        1.0.10                                                   
-#> + fansi        1.0.3                                                    
-#> + generics     0.1.3                                                    
-#> + glue         1.6.2                                                    
-#> + lifecycle    1.0.3                                                    
-#> + magrittr     2.0.3                                                    
-#> + pillar       1.8.1                                                    
-#> + pkgconfig    2.0.3                                                    
-#> + R6           2.5.1                                                    
-#> + rlang        1.0.6                                                    
-#> + tibble       3.1.8                                                    
-#> + tidyselect   1.2.0                                                    
-#> + utf8         1.2.2                                                    
-#> + vctrs        0.5.1                                                    
-#> + withr        2.5.0                                                    
-#>  No downloads are needed, 16 pkgs (9.42 MB) are cached                 
-#>  Installed R6 2.5.1  (66ms)                                            
-#>  Installed cli 3.4.1  (76ms)                                           
-#>  Installed dplyr 1.0.10  (111ms)                                       
-#>  Installed fansi 1.0.3  (119ms)                                        
-#>  Installed generics 0.1.3  (125ms)                                     
-#>  Installed glue 1.6.2  (132ms)                                         
-#>  Installed lifecycle 1.0.3  (149ms)                                    
-#>  Installed magrittr 2.0.3  (162ms)                                     
-#>  Installed pillar 1.8.1  (56ms)                                        
-#>  Installed pkgconfig 2.0.3  (35ms)                                     
-#>  Installed rlang 1.0.6  (57ms)                                         
-#>  Installed tibble 3.1.8  (41ms)                                        
-#>  Installed tidyselect 1.2.0  (40ms)                                    
-#>  Installed utf8 1.2.2  (37ms)                                          
-#>  Installed vctrs 0.5.1  (39ms)                                         
-#>  Installed withr 2.5.0  (31ms)                                         
-#>  1 pkg + 15 deps: added 16 [7.2s]                                      
-
-}} +\if{html}{\out{
}}\preformatted{pkg_install("dplyr") +}\if{html}{\out{
}} } \seealso{ diff --git a/man/pkg_name_check.Rd b/man/pkg_name_check.Rd index 07db18810..a8369add8 100644 --- a/man/pkg_name_check.Rd +++ b/man/pkg_name_check.Rd @@ -59,32 +59,7 @@ See the \code{dictionaries} argument. \section{Examples}{ -\if{html}{\out{
}}\preformatted{pkg_name_check("sicily") -}\if{html}{\out{
}}\if{html}{\out{ -
-#> ╔══════════════════════════════════════════════════════════════════════╗
-#>                             –*– sicily –*–                            
-#> ╚══════════════════════════════════════════════════════════════════════╝
-#> ┌──────────────────────────────────────────────────────────────────────┐
-#>    valid name            CRAN                 Bioconductor         
-#>    not a profanity                                                   
-#> └──────────────────────────────────────────────────────────────────────┘
-#> Wikipedia ───────────────────────────────────────────────────────────┐
-#>  Sicily Sicily (Italian: Sicilia [siˈtʃiːlja], Sicilian               
-#>  pronunciation: [sɪˈʃiːlja]) is the largest island in the             
-#>  Mediterranean Sea and one of the 20 regions of Italy. The Strait of  
-#>  Messina divides it from the region of Calabria in Southern Italy.    
-#>  It is one of the five Italian autonomous regions and is officially   
-#>  referred to as Regione Siciliana. The region has 5 million           
-#> 
-#> └──────────────────────────────── https://en.wikipedia.org/wiki/Sicily
-#> Wiktionary ──────────────────────────────────────────────────────────┐
-#>  sicily No English definition found                                   
-#> └────────────────────────────────────────────────────────────────────  ┘
-#> ┌──────────────────────────────────────────────────────────────────────┐
-#>  Sentiment: 😐 (0)                                                     
-#> └──────────────────────────────────────────────────────────────────────┘
-
-}} +\if{html}{\out{
}}\preformatted{pkg_name_check("sicily") +}\if{html}{\out{
}} } diff --git a/man/pkg_search.Rd b/man/pkg_search.Rd index 11c167b9d..241e1832e 100644 --- a/man/pkg_search.Rd +++ b/man/pkg_search.Rd @@ -9,7 +9,12 @@ pkg_search(query, ...) \arguments{ \item{query}{Search query string.} -\item{...}{Additional arguments passed to \code{\link[pkgsearch:pkg_search]{pkgsearch::pkg_search()}}} +\item{...}{ + Arguments passed on to \code{\link[pkgsearch:pkg_search]{pkgsearch::pkg_search}} + \describe{ + \item{\code{from}}{Where to start listing the results, for pagination.} + \item{\code{size}}{The number of results to list.} + }} } \value{ A data frame, that is also a \code{pak_search_result} object @@ -26,69 +31,13 @@ etc. Simple search -\if{html}{\out{
}}\preformatted{pkg_search("survival") -}\if{html}{\out{
}}\if{html}{\out{ -
-#>                                                                         
-#> 1 survival 3.4.0 -- by Terry M Therneau, 4 months ago                   
-#>   Survival Analysis                                                     
-#>                                                                         
-#> 2 survminer 0.4.9 -- by Alboukadel Kassambara, 2 years ago              
-#>   Drawing Survival Curves using 'ggplot2'                               
-#>                                                                         
-#> 3 flexsurv 2.2 -- by Christopher Jackson, 6 months ago                  
-#>   Flexible Parametric Survival and Multi-State Models                   
-#>                                                                         
-#> 4 muhaz 1.2.6.4 -- by David Winsemius, 2 years ago                      
-#>   Hazard Function Estimation in Survival Analysis                       
-#>                                                                         
-#> 5 pec 2022.5.4 -- by Thomas A. Gerds, 8 months ago                      
-#>   Prediction Error Curves for Risk Prediction Models in Survival Analysi
-#> s                                                                       
-#>                                                                         
-#> 6 randomForestSRC 3.1.1 -- by Udaya B. Kogalur, 5 months ago            
-#>   Fast Unified Random Forests for Survival, Regression, and Classificati
-#> on (RF-SRC)                                                             
-#>                                                                         
-#> 7 relsurv 2.2.8 -- by Damjan Manevski, 4 months ago                     
-#>   Relative Survival                                                     
-#>                                                                         
-#> 8 survRM2 1.0.4 -- by Hajime Uno, 6 months ago                          
-#>   Comparing Restricted Mean Survival Time                               
-#>                                                                         
-#> 9 titanic 0.1.0 -- by Paul Hendricks, 7 years ago                       
-#>   Titanic Passenger Survival Data Set                                   
-#>                                                                         
-#> 10 KMsurv 0.1.5 -- by Jun Yan, 10 years ago                             
-#>   Data sets from Klein and Moeschberger (1997), Survival Analysis       
-
-}} - +\if{html}{\out{
}}\preformatted{pkg_search("survival") +}\if{html}{\out{
}} See the underlying data frame -\if{html}{\out{
}}\preformatted{psro <- pkg_search("ropensci") +\if{html}{\out{
}}\preformatted{psro <- pkg_search("ropensci") psro[] -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 10 × 15                                                 
-#>    score package    version    title descr…¹ date                maint…²
-#>    <dbl> <chr>      <pckg_vrs> <chr> <chr>   <dttm>              <chr>  
-#>  1  538. webmockr   0.8.2      Stub… "Stubb… 2022-08-28 19:20:02 Scott …
-#>  2  520. RSelenium  1.7.9      R Bi… "Provi… 2022-09-02 07:10:11 Ju Yeo…
-#>  3  416. tracerer   2.2.2      Trac… "'BEAS… 2021-05-30 08:40:03 Richèl…
-#>  4  376. rfisheries 0.2        'Pro… "A pro… 2016-02-19 08:50:03 Karthi…
-#>  5  367. mcbette    1.15       Mode… "'BEAS… 2022-08-27 12:30:02 Richèl…
-#>  6  359. taxize     0.9.100    Taxo… "Inter… 2022-04-22 07:30:02 Zachar…
-#>  7  350. beastier   2.4.11     Call… "'BEAS… 2022-08-11 13:40:04 Richèl…
-#>  8  347. spocc      1.2.0      Inte… "A pro… 2021-01-05 19:50:03 Scott …
-#>  9  316. chromer    0.3        Inte… "A pro… 2022-10-27 22:45:36 Karl W…
-#> 10  315. visdat     0.5.3      Prel… "Creat… 2019-02-15 14:30:03 Nichol…
-#> # … with 8 more variables: maintainer_email <chr>, revdeps <int>,       
-#> #   downloads_last_month <int>, license <chr>, url <chr>,               
-#> #   bugreports <chr>, package_data <I<list>>, ago <chr>, and            
-#> #   abbreviated variable names ¹​description, ²​maintainer_name         
-
-}} +}\if{html}{\out{
}} } diff --git a/man/pkg_status.Rd b/man/pkg_status.Rd index 26ddbe796..e3e99ebcc 100644 --- a/man/pkg_status.Rd +++ b/man/pkg_status.Rd @@ -22,23 +22,8 @@ Display installed locations of a package \section{Examples}{ -\if{html}{\out{
}}\preformatted{pkg_status("MASS") -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 2 × 39                                                  
-#>   library    package title version depends repos…¹ license needs…² built
-#> * <chr>      <chr>   <chr> <chr>   <chr>   <chr>   <chr>   <lgl>   <chr>
-#> 1 /Users/ga… MASS    Supp… 7.3-58… R (>= … CRAN    GPL-2 … TRUE    R 4.…
-#> 2 /Library/… MASS    Supp… 7.3-58… R (>= … CRAN    GPL-2 … TRUE    R 4.…
-#> # … with 30 more variables: remotetype <chr>, remotepkgref <chr>,       
-#> #   remoteref <chr>, remoterepos <chr>, remotepkgplatform <chr>,        
-#> #   remotesha <chr>, imports <chr>, suggests <chr>, linkingto <chr>,    
-#> #   remotes <chr>, remotehost <chr>, remoterepo <chr>,                  
-#> #   remoteusername <chr>, enhances <chr>, biocviews <chr>,              
-#> #   remoteurl <chr>, remotesubdir <chr>, priority <chr>,                
-#> #   remoteetag <chr>, remotepackaged <chr>, md5sum <chr>, …             
-
-}} +\if{html}{\out{
}}\preformatted{pkg_status("MASS") +}\if{html}{\out{
}} } \seealso{ diff --git a/man/pkg_sysreqs.Rd b/man/pkg_sysreqs.Rd index ac71e83f1..e7a85726e 100644 --- a/man/pkg_sysreqs.Rd +++ b/man/pkg_sysreqs.Rd @@ -9,12 +9,12 @@ pkg_sysreqs(pkg, upgrade = TRUE, dependencies = NA, sysreqs_platform = NULL) \arguments{ \item{pkg}{Package names or package references. E.g. \itemize{ -\item \code{ggplot2}: package from CRAN, Bioconductor or a CRAN-like repository +\item \code{ggplot2} or \code{cran::ggplot2}: package from CRAN, Bioconductor or a CRAN-like repository in general, -\item \code{tidyverse/ggplot2}: package from GitHub, -\item \code{tidyverse/ggplot2@v3.4.0}: package from GitHub tag or branch, -\item \verb{https://examples.com/.../ggplot2_3.3.6.tar.gz}: package from URL, -\item \code{.}: package in the current working directory. +\item \code{tidyverse/ggplot2} or \code{github::tidyverse/ggplot2}: package from GitHub, +\item \code{tidyverse/ggplot2@v3.4.0} or \code{github::tidyverse/ggplot2@v3.4.0}: package from GitHub tag or branch, +\item \verb{url::https://examples.com/.../ggplot2_3.3.6.tar.gz}: package from URL, +\item \code{.} or \code{local::.}: package in the current working directory. } See "\link{Package sources}" for more details.} diff --git a/man/repo_add.Rd b/man/repo_add.Rd index f6620c4dd..98202a2f1 100644 --- a/man/repo_add.Rd +++ b/man/repo_add.Rd @@ -94,49 +94,18 @@ will trigger an error. \section{Exaples}{ -\if{html}{\out{
}}\preformatted{repo_add(PPMdplyr100 = "PPM@dplyr-1.0.0") +\if{html}{\out{
}}\preformatted{repo_add(PPMdplyr100 = "PPM@dplyr-1.0.0") repo_get() -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 7 × 5                                                   
-#>   name          url                         type  r_version bioc_version
-#> * <chr>         <chr>                       <chr> <chr>     <chr>       
-#> 1 CRAN          https://cloud.r-project.org cran  *         NA          
-#> 2 PPMdplyr100   https://packagemanager.pos… cran… *         NA          
-#> 3 BioCsoft      https://bioconductor.org/p… bioc  4.3.1     3.17        
-#> 4 BioCann       https://bioconductor.org/p… bioc  4.3.1     3.17        
-#> 5 BioCexp       https://bioconductor.org/p… bioc  4.3.1     3.17        
-#> 6 BioCworkflows https://bioconductor.org/p… bioc  4.3.1     3.17        
-#> 7 BioCbooks     https://bioconductor.org/p… bioc  4.3.1     3.17        
-
-}} - - -\if{html}{\out{
}}\preformatted{repo_resolve("PPM@2020-01-21") -}\if{html}{\out{
}}\if{html}{\out{ -
-#>                                       CRAN                              
-#> "https://packagemanager.posit.co/cran/245"                              
-
-}} - +}\if{html}{\out{
}} -\if{html}{\out{
}}\preformatted{repo_resolve("PPM@dplyr-1.0.0") -}\if{html}{\out{
}}\if{html}{\out{ -
-#>                                       CRAN                              
-#> "https://packagemanager.posit.co/cran/289"                              
-
-}} +\if{html}{\out{
}}\preformatted{repo_resolve("PPM@2020-01-21") +}\if{html}{\out{
}} +\if{html}{\out{
}}\preformatted{repo_resolve("PPM@dplyr-1.0.0") +}\if{html}{\out{
}} -\if{html}{\out{
}}\preformatted{repo_resolve("PPM@R-4.0.0") -}\if{html}{\out{
}}\if{html}{\out{ -
-#>                                       CRAN                              
-#> "https://packagemanager.posit.co/cran/276"                              
-
-}} +\if{html}{\out{
}}\preformatted{repo_resolve("PPM@R-4.0.0") +}\if{html}{\out{
}} } \seealso{ diff --git a/man/repo_get.Rd b/man/repo_get.Rd index 1ef531fdc..b983c2fea 100644 --- a/man/repo_get.Rd +++ b/man/repo_get.Rd @@ -27,20 +27,8 @@ Bioconductor repositories. See the \code{cran_mirror} and \code{bioc} arguments. \section{Examples}{ -\if{html}{\out{
}}\preformatted{repo_get() -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 5 × 5                                                   
-#>   name          url                                type  r_ver…¹ bioc_…²
-#> * <chr>         <chr>                              <chr> <chr>   <chr>  
-#> 1 CRAN          https://cloud.r-project.org        cran  *       NA     
-#> 2 BioCsoft      https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> 3 BioCann       https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> 4 BioCexp       https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> 5 BioCworkflows https://bioconductor.org/packages… bioc  4.2.2   3.16   
-#> # … with abbreviated variable names ¹​r_version, ²​bioc_version         
-
-}} +\if{html}{\out{
}}\preformatted{repo_get() +}\if{html}{\out{
}} } \seealso{ diff --git a/man/repo_status.Rd b/man/repo_status.Rd index 8c512d3eb..86af83f2c 100644 --- a/man/repo_status.Rd +++ b/man/repo_status.Rd @@ -67,69 +67,17 @@ summary of the data, and it returns its result invisibly. \section{Examples}{ -\if{html}{\out{
}}\preformatted{repo_status() -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 10 × 10                                                 
-#>    name     url   type  bioc_…¹ platf…² path  r_ver…³ ok     ping error 
-#>    <chr>    <chr> <chr> <chr>   <chr>   <chr> <chr>   <lgl> <dbl> <list>
-#>  1 CRAN     http… cran  NA      source  src/… 4.2     TRUE  0.269 <NULL>
-#>  2 CRAN     http… cran  NA      aarch6… bin/… 4.2     TRUE  0.265 <NULL>
-#>  3 BioCsoft http… bioc  3.16    source  src/… 4.2     TRUE  0.264 <NULL>
-#>  4 BioCsoft http… bioc  3.16    aarch6… bin/… 4.2     TRUE  0.271 <NULL>
-#>  5 BioCann  http… bioc  3.16    source  src/… 4.2     TRUE  0.383 <NULL>
-#>  6 BioCann  http… bioc  3.16    aarch6… bin/… 4.2     TRUE  0.392 <NULL>
-#>  7 BioCexp  http… bioc  3.16    source  src/… 4.2     TRUE  0.507 <NULL>
-#>  8 BioCexp  http… bioc  3.16    aarch6… bin/… 4.2     TRUE  0.739 <NULL>
-#>  9 BioCwor… http… bioc  3.16    source  src/… 4.2     TRUE  0.505 <NULL>
-#> 10 BioCwor… http… bioc  3.16    aarch6… bin/… 4.2     TRUE  0.766 <NULL>
-#> # … with abbreviated variable names ¹​bioc_version, ²​platform,         
-#> #   ³​r_version                                                         
-
-}} +\if{html}{\out{
}}\preformatted{repo_status() +}\if{html}{\out{
}} - -\if{html}{\out{
}}\preformatted{repo_status( +\if{html}{\out{
}}\preformatted{repo_status( platforms = c("windows", "macos"), r_version = c("4.0", "4.1") ) -}\if{html}{\out{
}}\if{html}{\out{ -
-#> # A data frame: 15 × 10                                                 
-#>    name          url    type  bioc_…¹ platf…² r_ver…³ path  ok      ping
-#>    <chr>         <chr>  <chr> <chr>   <chr>   <chr>   <chr> <lgl>  <dbl>
-#>  1 CRAN          https… cran  NA      i386+x… 4.0     bin/… TRUE   0.198
-#>  2 CRAN          https… cran  NA      i386+x… 4.1     bin/… TRUE   0.197
-#>  3 CRAN          https… cran  NA      aarch6… 4.1     bin/… TRUE   0.197
-#>  4 BioCsoft      https… bioc  3.12    i386+x… 4.0     bin/… TRUE   0.988
-#>  5 BioCann       https… bioc  3.12    i386+x… 4.0     bin/… TRUE   1.03 
-#>  6 BioCexp       https… bioc  3.12    i386+x… 4.0     bin/… TRUE   1.25 
-#>  7 BioCworkflows https… bioc  3.12    i386+x… 4.0     bin/… TRUE   1.47 
-#>  8 BioCsoft      https… bioc  3.14    i386+x… 4.1     bin/… TRUE   1.48 
-#>  9 BioCsoft      https… bioc  3.14    aarch6… 4.1     bin/… FALSE NA    
-#> 10 BioCann       https… bioc  3.14    i386+x… 4.1     bin/… TRUE   1.45 
-#> 11 BioCann       https… bioc  3.14    aarch6… 4.1     bin/… FALSE NA    
-#> 12 BioCexp       https… bioc  3.14    i386+x… 4.1     bin/… TRUE   1.72 
-#> 13 BioCexp       https… bioc  3.14    aarch6… 4.1     bin/… FALSE NA    
-#> 14 BioCworkflows https… bioc  3.14    i386+x… 4.1     bin/… TRUE   1.71 
-#> 15 BioCworkflows https… bioc  3.14    aarch6… 4.1     bin/… FALSE NA    
-#> # … with 1 more variable: error <list>, and abbreviated variable names  
-#> #   ¹​bioc_version, ²​platform, ³​r_version                             
-
-}} - +}\if{html}{\out{
}} -\if{html}{\out{
}}\preformatted{repo_ping() -}\if{html}{\out{
}}\if{html}{\out{ -
-#> Repository summary:                   source aarch64-apple-darwin20          
-#> CRAN          @ cloud.r-project.org       (194ms)
-#> BioCsoft      @ bioconductor.org          (352ms)
-#> BioCann       @ bioconductor.org          (511ms)
-#> BioCexp       @ bioconductor.org          (675ms)
-#> BioCworkflows @ bioconductor.org          (698ms)
-
-}} +\if{html}{\out{
}}\preformatted{repo_ping() +}\if{html}{\out{
}} } \seealso{