R/Rpacman
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Latest build

Browse Source
This commit is contained in:
Craig Williams
2023-09-28 09:44:06 +01:00
parent 788fab8610
commit b776fc7019
33 changed files with 527 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
man/activate.Rd Normal file
View File

@@ -0,0 +1,17 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/activate.R
\name{activate}
\alias{activate}
\title{Adds the pacman library path to the .libPaths variable, either as an extra
library or as the only library}
\usage{
activate(totalIsolation = FALSE)
}
\arguments{
\item{totalIsolation}{boolean Only refer to the pacman library, do not use
any user library paths}
}
\description{
Adds the pacman library path to the .libPaths variable, either as an extra
library or as the only library
}

21
man/add_package.Rd Normal file
View File

@@ -0,0 +1,21 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/add_package.R
\name{add_package}
\alias{add_package}
\title{Add a package to the project.}
\usage{
add_package(
packageName = NULL,
installOpts = list(Ncpus = parallel::detectCores())
)
}
\arguments{
\item{packageName}{boolean Only refer to the pacman library, do not use
any user library paths}
\item{installOpts}{boolean Only refer to the pacman library, do not use
any user library paths}
}
\description{
Add a package to the project.
}

28
man/compile_imports.Rd Normal file
View File

@@ -0,0 +1,28 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/compile_imports.R
\name{compile_imports}
\alias{compile_imports}
\title{Compile a structure containing the current state of the imports for the
project.}
\usage{
compile_imports(
custom_sources = empty_sources(),
installOpts = list(Ncpus = parallel::detectCores())
)
}
\arguments{
\item{custom_sources}{datatable A table containing any previously known
custom data sources}
\item{installOpts}{list Installer options for use when installing CRAN
packages}
}
\value{
A list containing R base imports, directly imported/used packages,
indirectly imported/used packages (aka dependencies) and any custom
import sources.
}
\description{
Compile a structure containing the current state of the imports for the
project.
}

14
man/empty_sources.Rd Normal file
View File

@@ -0,0 +1,14 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utils.R
\name{empty_sources}
\alias{empty_sources}
\title{Structure of the imports data table}
\usage{
empty_sources()
}
\value{
datatable Empty table with the imports column structure
}
\description{
Structure of the imports data table
}

23
man/format_str.Rd Normal file
View File

@@ -0,0 +1,23 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utils.R
\name{format_str}
\alias{format_str}
\title{Re-formats a string to fix the width by padding with spaces}
\usage{
format_str(str, width = NULL, justify = "left", ...)
}
\arguments{
\item{str}{A character vector of strings to format}
\item{width}{An optional width of the string to pad to}
\item{justify}{"left" or "right" justification}
\item{...}{formattable objects}
}
\value{
A formatted (padded) character vector
}
\description{
Re-formats a string to fix the width by padding with spaces
}

23
man/install_package_source.Rd Normal file
View File

@@ -0,0 +1,23 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/install_package_source.R
\name{install_package_source}
\alias{install_package_source}
\title{Installs a package from a custom source}
\usage{
install_package_source(
packageSource,
installOpts = list(Ncpus = parallel::detectCores())
)
}
\arguments{
\item{packageSource}{The custom source information for a package}
\item{installOpts}{list Installer options for use when installing CRAN
packages}
}
\value{
invisible return of the current snapshot
}
\description{
Installs a package from a custom source
}

11
man/isolate.Rd Normal file
View File

@@ -0,0 +1,11 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/isolate.R
\name{isolate}
\alias{isolate}
\title{Isolates the current environment to only the pacman library}
\usage{
isolate()
}
\description{
Isolates the current environment to only the pacman library
}

25
man/restore.Rd Normal file
View File

@@ -0,0 +1,25 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/restore.R
\name{restore}
\alias{restore}
\title{Restores the project from a pacman snapshot file. Installs any missing
packages. This can be done into the user library or the packman library
(see totalIsolation)}
\usage{
restore(
totalIsolation = FALSE,
installOpts = list(Ncpus = parallel::detectCores())
)
}
\arguments{
\item{totalIsolation}{boolean Only refer to the pacman library, do not use
any user library paths}
\item{installOpts}{list Settings to be passed to install.packages etc.
Defaults to installing with multiple cores.}
}
\description{
Restores the project from a pacman snapshot file. Installs any missing
packages. This can be done into the user library or the packman library
(see totalIsolation)
}

18
man/snapshot.Rd Normal file
View File

@@ -0,0 +1,18 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/snapshot.R
\name{snapshot}
\alias{snapshot}
\title{Save the current state of the project into the lock file as a snapshot}
\usage{
snapshot(installOpts = list(Ncpus = parallel::detectCores()))
}
\arguments{
\item{installOpts}{list Installer options for use when installing CRAN
packages}
}
\value{
invisible return of the current snapshot
}
\description{
Save the current state of the project into the lock file as a snapshot
}

18
man/snapshot_create.Rd Normal file
View File

@@ -0,0 +1,18 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/snapshot_create.R
\name{snapshot_create}
\alias{snapshot_create}
\title{Create a snapshot of the project packages. Does not save the snapshot (see snapshot_save)}
\usage{
snapshot_create(installOpts = list(Ncpus = parallel::detectCores()))
}
\arguments{
\item{installOpts}{list Installer options for use when installing CRAN
packages}
}
\value{
A list containing the current state of the project packages
}
\description{
Create a snapshot of the project packages. Does not save the snapshot (see snapshot_save)
}

14
man/snapshot_history.Rd Normal file
View File

@@ -0,0 +1,14 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/snapshot_history.R
\name{snapshot_history}
\alias{snapshot_history}
\title{Load the existing snapshot history of the project}
\usage{
snapshot_history()
}
\value{
A list containing the previous snapshots
}
\description{
Load the existing snapshot history of the project
}

14
man/snapshot_latest.Rd Normal file
View File

@@ -0,0 +1,14 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/snapshot_latest.R
\name{snapshot_latest}
\alias{snapshot_latest}
\title{Load the latest snapshot state from the lock file}
\usage{
snapshot_latest()
}
\value{
A list containing the last saved snapshot of the project state
}
\description{
Load the latest snapshot state from the lock file
}

14
man/stop_quietly.Rd Normal file
View File

@@ -0,0 +1,14 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utils.R
\name{stop_quietly}
\alias{stop_quietly}
\title{Calls stop() returning to the top level but masks the message}
\usage{
stop_quietly(...)
}
\arguments{
\item{...}{ignored}
}
\description{
Calls stop() returning to the top level but masks the message
}