{"id":17961197,"url":"https://github.com/erictleung/hp","last_synced_at":"2025-04-03T18:41:50.520Z","repository":{"id":72464167,"uuid":"395377678","full_name":"erictleung/hp","owner":"erictleung","description":"Pipe a function into help()","archived":false,"fork":false,"pushed_at":"2021-08-13T19:31:54.000Z","size":230,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-16T07:56:43.286Z","etag":null,"topics":["documentation","help","magrittr","pipe","r","rstats","rstudio"],"latest_commit_sha":null,"homepage":"https://erictleung.com/hp","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/erictleung.png","metadata":{"files":{"readme":"README.Rmd","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-12T16:16:50.000Z","updated_at":"2021-08-13T19:30:44.000Z","dependencies_parsed_at":"2023-03-14T13:30:28.888Z","dependency_job_id":null,"html_url":"https://github.com/erictleung/hp","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erictleung%2Fhp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erictleung%2Fhp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erictleung%2Fhp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erictleung%2Fhp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/erictleung","download_url":"https://codeload.github.com/erictleung/hp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247060849,"owners_count":20877158,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","help","magrittr","pipe","r","rstats","rstudio"],"created_at":"2024-10-29T11:08:37.850Z","updated_at":"2025-04-03T18:41:50.480Z","avatar_url":"https://github.com/erictleung.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, include = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/README-\",\n  out.width = \"100%\"\n)\n```\n\n# hp\n\n\u003c!-- badges: start --\u003e\n[![R-CMD-check](https://github.com/erictleung/hp/workflows/R-CMD-check/badge.svg)](https://github.com/erictleung/hp/actions)\n\u003c!-- badges: end --\u003e\n\nThe goal of hp is to allow you to pipe a function into help using the {magrittr}\npipe, `%\u003e%`.\n\n![Demo of the h function using code shown in the examples section](man/figures/hp.gif)\n\n\n## Installation\n\nThe development version from [GitHub](https://github.com/erictleung/hp) with:\n\n```r\n# install.packages(\"devtools\")\nremotes::install_github(\"erictleung/hp\")\n```\n\n## Example\n\nThis is a basic example which shows you how to solve a common problem:\n\n```{r example, eval=FALSE}\nlibrary(hp)\nlibrary(dplyr)\n\n# Simple single function\nt.test %\u003e% h\n\n# Simple single function with parentheses\ndim() %\u003e% h\n\n# Function but specifying package\ndplyr::across %\u003e% h\n\n# Function but specifying package with parentheses\ndplyr::summarise() %\u003e% h\n```\n\n\n## Notes\n\nThe `h()` function is designed to only work interactively.\n\nAdditionally, this package was created because the {magrittr} pipe doesn't play\nwell with piping in functions into the `help()` function.\n\nThis was fixed with the new native R pipe operator, `|\u003e`.\n\n```r\ndim |\u003e help()\n```\n\nNote, the left side should not have parentheses or R will warn you that the\n`help()` function requires, \"a name, length-one character vector or reserved\nword.\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferictleung%2Fhp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ferictleung%2Fhp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferictleung%2Fhp/lists"}