Skip to content

Commit

Permalink
URLs and spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
wlandau committed Oct 3, 2024
1 parent 1345680 commit 62e08eb
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 11 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Description: Like similar profiling tools,
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>,
<https://protobuf.dev>,
and <https://github.com/r-prof/profile>, respectively.
Depends:
R (>= 3.3.0)
Expand Down
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@

# proffer 0.0.2

* Respond to CRAN feedback on version 0.0.1. Software and API names in the `DESCRIPTION` now appear in single quotes, the grammatical errors are gone, and new links reference the methodological background and context of `proffer` (<https://github.com/google/pprof>, <https://developers.google.com/protocol-buffers>, and <https://github.com/r-prof/profile>).
* Respond to CRAN feedback on version 0.0.1. Software and API names in the `DESCRIPTION` now appear in single quotes, the grammatical errors are gone, and new links reference the methodological background and context of `proffer`.
* Use `processx` instead of `callr` (#5, @gaborcsardi).
* Add Graphviz installation instructions.
* Add pprof and Graphviz as system requirements.
Expand Down
6 changes: 3 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ knitr::opts_chunk$set(
[![license](https://img.shields.io/badge/licence-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![active](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![check](https://github.com/r-prof/proffer/workflows/check/badge.svg)](https://github.com/r-prof/proffer/actions?workflow=check)
[![codecov](https://codecov.io/github/r-prof/proffer/coverage.svg?branch=main)](https://codecov.io/github/r-prof/proffer?branch=main)
[![codecov](https://codecov.io/github/r-prof/proffer/coverage.svg?branch=main)](https://app.codecov.io/github/r-prof/proffer?branch=main)

The `proffer` package profiles R code to find bottlenecks. Visit <https://r-prof.github.io/proffer/> for documentation. <https://r-prof.github.io/proffer/reference/index.html> has a complete list of available functions in the package.

Expand Down Expand Up @@ -210,7 +210,7 @@ Profilers identify bottlenecks, but the do not offer solutions. It helps to lear

### profvis

The [`profvis`](https://github.com/rstudio/profvis) is much easier to install than `proffer` and equally easy to invoke.
The [`profvis`](https://github.com/r-lib/profvis) package is easier to install than `proffer` and easy to invoke.

```{r, eval = FALSE}
library(profvis)
Expand All @@ -224,7 +224,7 @@ profvis({
})
```

However, `profvis`-generated flame graphs can be [difficult to read](https://github.com/rstudio/profvis/issues/115) and [slow to respond to mouse clicks](https://github.com/rstudio/profvis/issues/104).
However, `profvis`-generated flame graphs can be [difficult to read](https://github.com/r-lib/profvis/issues/115) and [slow to respond to mouse clicks](https://github.com/r-lib/profvis/issues/104).

<center>
<a href="https://r-prof.github.io/proffer/reference/figures/profvis.png">
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![license](https://img.shields.io/badge/licence-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![active](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![check](https://github.com/r-prof/proffer/workflows/check/badge.svg)](https://github.com/r-prof/proffer/actions?workflow=check)
[![codecov](https://codecov.io/github/r-prof/proffer/coverage.svg?branch=main)](https://codecov.io/github/r-prof/proffer?branch=main)
[![codecov](https://codecov.io/github/r-prof/proffer/coverage.svg?branch=main)](https://app.codecov.io/github/r-prof/proffer?branch=main)

The `proffer` package profiles R code to find bottlenecks. Visit
<https://r-prof.github.io/proffer/> for documentation.
Expand Down Expand Up @@ -74,7 +74,7 @@ system.time({
x <- data.frame(x = x, y = y)
})
#> user system elapsed
#> 0.019 0.000 0.020
#> 0.018 0.001 0.019
```

Moral of the story: before you optimize, throw away your assumptions and
Expand Down Expand Up @@ -245,8 +245,8 @@ alternatives to try.

### profvis

The [`profvis`](https://github.com/rstudio/profvis) is much easier to
install than `proffer` and equally easy to invoke.
The [`profvis`](https://github.com/r-lib/profvis) package is easier to
install than `proffer` and easy to invoke.

``` r
library(profvis)
Expand All @@ -261,8 +261,8 @@ profvis({
```

However, `profvis`-generated flame graphs can be [difficult to
read](https://github.com/rstudio/profvis/issues/115) and [slow to
respond to mouse clicks](https://github.com/rstudio/profvis/issues/104).
read](https://github.com/r-lib/profvis/issues/115) and [slow to respond
to mouse clicks](https://github.com/r-lib/profvis/issues/104).

<center>
<a href="https://r-prof.github.io/proffer/reference/figures/profvis.png">
Expand Down
1 change: 1 addition & 0 deletions inst/WORDLIST
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Jupyter
lang
nz
pprof
pre
Pprof
processx
profiler
Expand Down

0 comments on commit 62e08eb

Please sign in to comment.