doc: Add to the top links

nathaneastwood · Oct 4, 2022 · e910fd7 · e910fd7
1 parent 89aaae8
commit e910fd7
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 0 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -14,6 +14,8 @@ knitr::opts_chunk$set(
 options(poorman.summarise.inform = FALSE)
 ```
 
+<a name="readme-top"></a>
+
 # {poorman} <a href='https://nathaneastwood.github.io/tags/poorman/'><img src='man/figures/logo.png' align="right" height="139" /></a>
 
 [![CRAN status](https://www.r-pkg.org/badges/version/poorman)](https://cran.r-project.org/package=poorman)
@@ -41,6 +43,8 @@ options(poorman.summarise.inform = FALSE)
 
 For more details on the functionality available within {poorman}, check out the {poorman} series of blog posts [here](https://nathaneastwood.github.io/tags/poorman/).
 
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
 ## Installation
 
 You can install:
@@ -58,6 +62,8 @@ remotes::install_github("nathaneastwood/poorman")
 install.packages("poorman")
 ```
 
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
 ## Docker
 
 If you'd like to try out the latest version of the package on CRAN using Docker, you can run the latest image with:
@@ -66,6 +72,8 @@ If you'd like to try out the latest version of the package on CRAN using Docker,
 docker run --rm -it nathaneastwood/poorman
 ```
 
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
 ## Usage
 
 ```{r usage}
@@ -82,8 +90,12 @@ mtcars %>%
   ungroup()
 ```
 
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
 ## Related Work
 
 * [{dplyr}](https://github.com/tidyverse/dplyr)
 * [{bplyr}](https://github.com/yonicd/bplyr) - imports {magrittr} and {rlang}; it prepends functions with `b_*()`, e.g. `b_select()`.
 * [{tbltools}](https://github.com/mkearney/tbltools) - imports {magrittr} and appends `*_data()` to each of its functions, e.g. `select_data()`.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
+<a name="readme-top"></a>
+
 # {poorman} <a href='https://nathaneastwood.github.io/tags/poorman/'><img src='man/figures/logo.png' align="right" height="139" /></a>
 
 [![CRAN
@@ -37,6 +39,10 @@ For more details on the functionality available within {poorman}, check
 out the {poorman} series of blog posts
 [here](https://nathaneastwood.github.io/tags/poorman/).
 
+<p align="right">
+(<a href="#readme-top">back to top</a>)
+</p>
+
 ## Installation
 
 You can install:
@@ -55,6 +61,10 @@ remotes::install_github("nathaneastwood/poorman")
 install.packages("poorman")
 ```
 
+<p align="right">
+(<a href="#readme-top">back to top</a>)
+</p>
+
 ## Docker
 
 If you’d like to try out the latest version of the package on CRAN using
@@ -64,6 +74,10 @@ Docker, you can run the latest image with:
 docker run --rm -it nathaneastwood/poorman
 ```
 
+<p align="right">
+(<a href="#readme-top">back to top</a>)
+</p>
+
 ## Usage
 
 ``` r
@@ -95,6 +109,10 @@ mtcars %>%
 # 6  1   8 15.40000 0.5656854
 ```
 
+<p align="right">
+(<a href="#readme-top">back to top</a>)
+</p>
+
 ## Related Work
 
 -   [{dplyr}](https://github.com/tidyverse/dplyr)
@@ -103,3 +121,7 @@ mtcars %>%
 -   [{tbltools}](https://github.com/mkearney/tbltools) - imports
     {magrittr} and appends `*_data()` to each of its functions,
     e.g. `select_data()`.
+
+<p align="right">
+(<a href="#readme-top">back to top</a>)
+</p>