Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/erictleung/hp

Pipe a function into help()

https://github.com/erictleung/hp

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.6%) to scientific vocabulary

Keywords

documentation help magrittr pipe r rstats rstudio
Last synced: 4 months ago · JSON representation

Repository

Pipe a function into help()

Basic Info
  • Host: GitHub
  • Owner: erictleung
  • License: other
  • Language: R
  • Default Branch: main
  • Homepage: https://erictleung.com/hp
  • Size: 225 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
documentation help magrittr pipe r rstats rstudio
Created over 4 years ago · Last pushed over 4 years ago
Metadata Files
Readme License Code of conduct

README.Rmd 

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# hp


[![R-CMD-check](https://github.com/erictleung/hp/workflows/R-CMD-check/badge.svg)](https://github.com/erictleung/hp/actions)


The goal of hp is to allow you to pipe a function into help using the {magrittr}
pipe, `%>%`.

![Demo of the h function using code shown in the examples section](man/figures/hp.gif)


## Installation

The development version from [GitHub](https://github.com/erictleung/hp) with:

```r
# install.packages("devtools")
remotes::install_github("erictleung/hp")
```

## Example

This is a basic example which shows you how to solve a common problem:

```{r example, eval=FALSE}
library(hp)
library(dplyr)

# Simple single function
t.test %>% h

# Simple single function with parentheses
dim() %>% h

# Function but specifying package
dplyr::across %>% h

# Function but specifying package with parentheses
dplyr::summarise() %>% h
```


## Notes

The `h()` function is designed to only work interactively.

Additionally, this package was created because the {magrittr} pipe doesn't play
well with piping in functions into the `help()` function.

This was fixed with the new native R pipe operator, `|>`.

```r
dim |> help()
```

Note, the left side should not have parentheses or R will warn you that the
`help()` function requires, "a name, length-one character vector or reserved
word."

Owner

  • Name: Eric Leung
  • Login: erictleung
  • Kind: user
  • Location: New York, NY

Data science generalist. Sharing knowledge and optimizing tools for learning and growth. Open-source and open-data advocate. Community learner.

GitHub Events

Total
Last Year

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 7
  • Total Committers: 1
  • Avg Commits per committer: 7.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Eric Leung e****c@e****m 7
Committer Domains (Top 20 + Academic)
erictleung.com: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-r v1 composite
.github/workflows/pkgdown.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
DESCRIPTION cran
  • dplyr * imports
  • magrittr * imports
  • purrr * imports