From 62e08eb56a26d6d5f886bc71fbd04a12ddb3c0b3 Mon Sep 17 00:00:00 2001 From: wlandau Date: Thu, 3 Oct 2024 11:16:19 -0400 Subject: [PATCH] URLs and spelling --- DESCRIPTION | 2 +- NEWS.md | 2 +- README.Rmd | 6 +++--- README.md | 12 ++++++------ inst/WORDLIST | 1 + 5 files changed, 12 insertions(+), 11 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 716757e..e00a153 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -33,7 +33,7 @@ Description: Like similar profiling tools, To learn about the implementations and methodologies of 'pprof', 'profile', and protocol buffers, visit . - , + , and , respectively. Depends: R (>= 3.3.0) diff --git a/NEWS.md b/NEWS.md index 49b8012..0eaa2af 100644 --- a/NEWS.md +++ b/NEWS.md @@ -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` (, , and ). +* 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. diff --git a/README.Rmd b/README.Rmd index e828223..0591f8d 100644 --- a/README.Rmd +++ b/README.Rmd @@ -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 for documentation. has a complete list of available functions in the package. @@ -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) @@ -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).
diff --git a/README.md b/README.md index 34c4534..81538ed 100644 --- a/README.md +++ b/README.md @@ -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 for documentation. @@ -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 @@ -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) @@ -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).
diff --git a/inst/WORDLIST b/inst/WORDLIST index 52287a9..b08c648 100644 --- a/inst/WORDLIST +++ b/inst/WORDLIST @@ -20,6 +20,7 @@ Jupyter lang nz pprof +pre Pprof processx profiler