install_go

On Linux, this function actually installs Go,
which comes with its own
installation of <code>pprof</code>. On Mac and Windows, the function
simply points the user to a link to download the installer.
Assumes amd64 architecture.

Like similar profiling tools,
the 'proffer' package automatically detects
sources of slowness in R code.
The distinguishing feature of 'proffer' is its utilization of
'pprof', which supplies interactive visualizations
that are efficient and easy to interpret.
Behind the scenes, the 'profile' package converts
native Rprof() data to a protocol buffer
that 'pprof' understands.
For the documentation of 'proffer',
visit <https://r-prof.github.io/proffer/>.
To learn about the implementations and methodologies of
'pprof', 'profile', and protocol buffers,
visit <https://github.com/google/pprof>.
<https://developers.google.com/protocol-buffers>,
and <https://github.com/r-prof/profile>, respectively.

Landau William

proffer

Profile R Code and Visualize with 'Pprof'

 Eli Lilly and Company

install_go function

<dl><dt>destination</dt>
<dd>Only relevant to Linux,
full path to the Go installation with the <code>pprof</code> and Go executables.
Defaults to <code>Sys.getenv("HOME")</code>, which means the default
Go installation path is <code>file.path(Sys.getenv("HOME"), "go")</code>.
That means the Go binary will be at
<code>file.path(Sys.getenv("HOME"), "go/bin/go")</code>
and <code>pprof</code> will be at
<code>file.path(Sys.getenv("HOME"), "go/pkg/tool/linux_amd64/pprof")</code>.
You will need to set environment variables in your <code>.Renviron</code> file,
e.g. <code>PROFFER_PPROF_BIN=/home/you/go/pkg/tool/linux_amd64/pprof</code>
and <code>PROFFER_GO_BIN=/home/you/go/bin/go</code>. <code><a href="https://usethis.r-lib.org/reference/edit.html">usethis::edit_r_environ()</a></code>
is helpful for this.</dd>
<dt>version</dt>
<dd>Character, a version string such as <code>"1.19.5"</code>.</dd>
<dt>quiet</dt>
<dd>Logical, whether to suppress console messages.</dd></dl>

Arguments

Install pprof and Go on Linux — install_go

<dl>

<dt>destination</dt>
<dd>Only relevant to Linux,
full path to the Go installation with the <code>pprof</code> and Go executables.
Defaults to <code>Sys.getenv("HOME")</code>, which means the default
Go installation path is <code>file.path(Sys.getenv("HOME"), "go")</code>.
That means the Go binary will be at
<code>file.path(Sys.getenv("HOME"), "go/bin/go")</code>
and <code>pprof</code> will be at
<code>file.path(Sys.getenv("HOME"), "go/pkg/tool/linux_amd64/pprof")</code>.
You will need to set environment variables in your <code>.Renviron</code> file,
e.g. <code>PROFFER_PPROF_BIN=/home/you/go/pkg/tool/linux_amd64/pprof</code>
and <code>PROFFER_GO_BIN=/home/you/go/bin/go</code>. <code><a href='https://usethis.r-lib.org/reference/edit.html'>usethis::edit_r_environ()</a></code>
is helpful for this.</dd>


<dt>version</dt>
<dd>Character, a version string such as <code>"1.19.5"</code>.</dd>


<dt>quiet</dt>
<dd>Logical, whether to suppress console messages.</dd>

</dl>

install_go: Install pprof and Go on Linux

Description

Usage

Arguments

Details