{"id":23099314,"url":"https://github.com/maurolepore/pkgdoc","last_synced_at":"2025-08-16T13:31:03.827Z","repository":{"id":89221771,"uuid":"163194950","full_name":"maurolepore/pkgdoc","owner":"maurolepore","description":"[R-package] Reference multiple R-packages in one place","archived":false,"fork":false,"pushed_at":"2024-10-27T16:39:10.000Z","size":693,"stargazers_count":1,"open_issues_count":32,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-27T19:40:02.042Z","etag":null,"topics":["devlopment","metapackage","package","pkgdoc","pkgdown","r","reference","vignette","website"],"latest_commit_sha":null,"homepage":"https://maurolepore.github.io/pkgdoc/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maurolepore.png","metadata":{"files":{"readme":"README.Rmd","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"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":"2018-12-26T15:47:06.000Z","updated_at":"2021-10-30T02:47:16.000Z","dependencies_parsed_at":"2023-06-14T12:00:36.881Z","dependency_job_id":null,"html_url":"https://github.com/maurolepore/pkgdoc","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/maurolepore%2Fpkgdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maurolepore%2Fpkgdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maurolepore%2Fpkgdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maurolepore%2Fpkgdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maurolepore","download_url":"https://codeload.github.com/maurolepore/pkgdoc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230038867,"owners_count":18163320,"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":["devlopment","metapackage","package","pkgdoc","pkgdown","r","reference","vignette","website"],"created_at":"2024-12-16T23:18:51.304Z","updated_at":"2024-12-16T23:18:52.059Z","avatar_url":"https://github.com/maurolepore.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 setup, 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# pkgdoc (deprecated)\n\nSee https://github.com/maurolepore/dverse\n\n[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)\n[![Travis build status](https://travis-ci.org/maurolepore/pkgdoc.svg?branch=master)](https://travis-ci.org/maurolepore/pkgdoc)\n[![Coverage status](https://coveralls.io/repos/github/maurolepore/pkgdoc/badge.svg)](https://coveralls.io/r/maurolepore/pkgdoc?branch=master)\n[![CRAN status](https://www.r-pkg.org/badges/version/pkgdoc)](https://cran.r-project.org/package=pkgdoc)\n\nDataframe the documentation of available packages, and reference objects across multiple packages by package or concept. Combined with `krittr::kable()` or `DT::datatable()`, __pkgdoc__ allows you to reference functions by package or concept across multiple packages and to provide links to each topic's help file (similar to the Reference section of a [__pkgdown__](https://pkgdown.r-lib.org/) website but not limited to a single package).\n\n* [Reference and tutorial](https://maurolepore.github.io/pkgdoc/articles/siteonly/reference.html)\n* [__pkgdoc__ in action](https://forestgeo.github.io/fgeo/articles/siteonly/reference.html)\n\n## Installation\n\n``` r\n# install.packages(\"devtools\")\ndevtools::install_github(\"maurolepore/pkgdoc\")\n```\n\n## Example\n\n```{r}\nlibrary(pkgdoc)\n```\n\n`search_docs()` creates a dataframe of documentation available to you.\n\n```{r example}\n# Documentation of all installed packages\nsearch_docs()\n\nsome_packages \u003c- c(\"utils\", \"base\")\nsearch_docs(some_packages)\n```\n\n`reference_package()` and `reference_concept()` allow you to pick specific documentation.\n\n```{r}\nreference_package(c(\"stats\", \"MASS\"))\n\nreference_concept(c(\"combine strings\", \"files\", \"PCA\"))\n```\n\nUse `knittr::kable()` or `DT::datatable()` for the links to become clickable.\n\n```{r}\nlibrary(fgeo)\n\nreference_concept(\n  c(\"datasets\", \"plot functions\"),\n  url = \"https://forestgeo.github.io/\",\n  ) %\u003e% \n  arrange(concept) %\u003e%\n  head() %\u003e% \n  knitr::kable()\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaurolepore%2Fpkgdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaurolepore%2Fpkgdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaurolepore%2Fpkgdoc/lists"}