diff --git a/apple-touch-icon-120x120.png b/apple-touch-icon-120x120.png index 17806aa..9c07fb2 100644 Binary files a/apple-touch-icon-120x120.png and b/apple-touch-icon-120x120.png differ diff --git a/apple-touch-icon-152x152.png b/apple-touch-icon-152x152.png index 3563dc1..2dc812c 100644 Binary files a/apple-touch-icon-152x152.png and b/apple-touch-icon-152x152.png differ diff --git a/apple-touch-icon-180x180.png b/apple-touch-icon-180x180.png index 261049c..52047e7 100644 Binary files a/apple-touch-icon-180x180.png and b/apple-touch-icon-180x180.png differ diff --git a/apple-touch-icon-60x60.png b/apple-touch-icon-60x60.png index 91c9f4b..c85d3bf 100644 Binary files a/apple-touch-icon-60x60.png and b/apple-touch-icon-60x60.png differ diff --git a/apple-touch-icon-76x76.png b/apple-touch-icon-76x76.png index 79c1518..6eeeb5b 100644 Binary files a/apple-touch-icon-76x76.png and b/apple-touch-icon-76x76.png differ diff --git a/apple-touch-icon.png b/apple-touch-icon.png index 6a137bd..5b1910e 100644 Binary files a/apple-touch-icon.png and b/apple-touch-icon.png differ diff --git a/favicon-16x16.png b/favicon-16x16.png index 4266df0..10639bb 100644 Binary files a/favicon-16x16.png and b/favicon-16x16.png differ diff --git a/favicon-32x32.png b/favicon-32x32.png index a66ec86..456f48f 100644 Binary files a/favicon-32x32.png and b/favicon-32x32.png differ diff --git a/index.html b/index.html index b76b9b7..5f6d3f4 100644 --- a/index.html +++ b/index.html @@ -85,11 +85,11 @@

Example

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

-link::to(dplyr::mutate)
+link::to(dplyr::mutate)
 #> <a href="https://dplyr.tidyverse.org/reference/mutate.html">dplyr::mutate()</a>
-link::to(package = "dplyr")
+link::to(package = "dplyr")
 #> <a href="https://dplyr.tidyverse.org">dplyr</a>
-link::to("gather", package = "tidyr")
+link::to("gather", package = "tidyr")
 #> <a href="https://tidyr.tidyverse.org/reference/gather.html">tidyr::gather()</a>
diff --git a/pkgdown.yml b/pkgdown.yml index fee3f22..267f16e 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 2.19.2 pkgdown: 2.0.7 pkgdown_sha: ~ articles: {} -last_built: 2024-02-23T18:12Z +last_built: 2024-02-23T18:14Z urls: reference: http://link.tada.science/reference article: http://link.tada.science/articles diff --git a/reference/Rplot001.png b/reference/Rplot001.png new file mode 100644 index 0000000..17a3580 Binary files /dev/null and b/reference/Rplot001.png differ diff --git a/reference/index.html b/reference/index.html index 0ef78a4..2fcecae 100644 --- a/reference/index.html +++ b/reference/index.html @@ -1,5 +1,5 @@ - • linkFunction reference • link @@ -37,10 +37,26 @@
-

+

Function reference

- +
+

All functions

+ + + + +
+ + + + +
+ + to() +
+
Create a link to a function or a package
+
diff --git a/reference/to.html b/reference/to.html new file mode 100644 index 0000000..c38d94b --- /dev/null +++ b/reference/to.html @@ -0,0 +1,127 @@ + +Create a link to a function or a package — to • link + Skip to contents + + +
+
+
+

Create a link to a function or a package

+ Source: R/to.R +
to.Rd
+
+ +
+

Create a link to a function or a package

+
+ +
+

Usage

+ 
to(topic, package)
+
+ +
+

Arguments

+
topic
+

topic

+ + +
package
+

package

+ +
+ +
+

Examples

+ 
link::to
+#> function (topic, package) 
+#> {
+#>     if (missing(topic)) {
+#>         if (missing(package) || !is_string(package)) {
+#>             cli_abort("{.arg package} must be a single string")
+#>         }
+#>         link(downlit::href_package(package), package)
+#>     }
+#>     else {
+#>         if (!missing(package) && is_string(package)) {
+#>             text <- glue::glue("{package}::{topic}()")
+#>             url <- downlit::href_topic(topic, package = package)
+#>             if (is.na(url)) {
+#>                 cli_abort("Can't find link for {text}")
+#>             }
+#>             link(url, text)
+#>         }
+#>         else {
+#>             topic <- enexpr(topic)
+#>             if (!is_call(topic, "::")) {
+#>                 cli_abort("{.arg topic} must be of the form <pkg>::<topic>")
+#>             }
+#>             package <- as.character(topic[[2]])
+#>             topic <- as.character(topic[[3]])
+#>             text <- glue::glue("{package}::{topic}()")
+#>             link(downlit::href_topic(topic, package = package), 
+#>                 text)
+#>         }
+#>     }
+#> }
+#> <bytecode: 0x5611ad320810>
+#> <environment: namespace:link>
+if (FALSE) {
+  link::to(dplyr::summarise)
+  link::to(package = "dplyr")
+  link::to("gather", package = "tidyr")
+}
+
+
+
+
+ + +
+

Developed by Romain François.

+
+ +
+

Site built with pkgdown 2.0.7.

+
+ +
+ + + + + + + diff --git a/search.json b/search.json index 60ae14f..5aa5505 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":[]},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement codeofconduct@posit.co. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired [Mozilla’s code conduct enforcement ladder][https://github.com/mozilla/inclusion]. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"http://link.tada.science/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to link","title":"Contributing to link","text":"outlines propose change link. detailed discussion contributing tidyverse packages, please see development contributing guide code review principles.","code":""},{"path":"http://link.tada.science/CONTRIBUTING.html","id":"fixing-typos","dir":"","previous_headings":"","what":"Fixing typos","title":"Contributing to link","text":"can fix typos, spelling mistakes, grammatical errors documentation directly using GitHub web interface, long changes made source file. generally means ’ll need edit roxygen2 comments .R, .Rd file. can find .R file generates .Rd reading comment first line.","code":""},{"path":"http://link.tada.science/CONTRIBUTING.html","id":"bigger-changes","dir":"","previous_headings":"","what":"Bigger changes","title":"Contributing to link","text":"want make bigger change, ’s good idea first file issue make sure someone team agrees ’s needed. ’ve found bug, please file issue illustrates bug minimal reprex (also help write unit test, needed). See guide create great issue advice.","code":""},{"path":"http://link.tada.science/CONTRIBUTING.html","id":"pull-request-process","dir":"","previous_headings":"Bigger changes","what":"Pull request process","title":"Contributing to link","text":"Fork package clone onto computer. haven’t done , recommend using usethis::create_from_github(\"tadascience/link\", fork = TRUE). Install development dependencies devtools::install_dev_deps(), make sure package passes R CMD check running devtools::check(). R CMD check doesn’t pass cleanly, ’s good idea ask help continuing. Create Git branch pull request (PR). recommend using usethis::pr_init(\"brief-description--change\"). Make changes, commit git, create PR running usethis::pr_push(), following prompts browser. title PR briefly describe change. body PR contain Fixes #issue-number. user-facing changes, add bullet top NEWS.md (.e. just first header). Follow style described https://style.tidyverse.org/news.html.","code":""},{"path":"http://link.tada.science/CONTRIBUTING.html","id":"code-style","dir":"","previous_headings":"Bigger changes","what":"Code style","title":"Contributing to link","text":"New code follow tidyverse style guide. can use styler package apply styles, please don’t restyle code nothing PR. use roxygen2, Markdown syntax, documentation. use testthat unit tests. Contributions test cases included easier accept.","code":""},{"path":"http://link.tada.science/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contributing to link","text":"Please note link project released Contributor Code Conduct. contributing project agree abide terms.","code":""},{"path":"http://link.tada.science/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 tada⬢science Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"http://link.tada.science/SUPPORT.html","id":null,"dir":"","previous_headings":"","what":"Getting help with link","title":"Getting help with link","text":"Thanks using link! filing issue, places explore pieces put together make process smooth possible.","code":""},{"path":"http://link.tada.science/SUPPORT.html","id":"make-a-reprex","dir":"","previous_headings":"","what":"Make a reprex","title":"Getting help with link","text":"Start making minimal reproducible example using reprex package. haven’t heard used reprex , ’re treat! Seriously, reprex make R-question-asking endeavors easier (pretty insane ROI five ten minutes ’ll take learn ’s ). additional reprex pointers, check Get help! section tidyverse site.","code":""},{"path":"http://link.tada.science/SUPPORT.html","id":"where-to-ask","dir":"","previous_headings":"","what":"Where to ask?","title":"Getting help with link","text":"Armed reprex, next step figure ask. ’s question: start community.rstudio.com, /StackOverflow. people answer questions. ’s bug: ’re right place, file issue. ’re sure: let community help figure ! problem bug feature request, can easily return report . opening new issue, sure search issues pull requests make sure bug hasn’t reported /already fixed development version. default, search pre-populated :issue :open. can edit qualifiers (e.g. :pr, :closed) needed. example, ’d simply remove :open search issues repo, open closed.","code":""},{"path":"http://link.tada.science/SUPPORT.html","id":"what-happens-next","dir":"","previous_headings":"","what":"What happens next?","title":"Getting help with link","text":"efficient possible, development tidyverse packages tends bursty, shouldn’t worry don’t get immediate response. Typically don’t look repo sufficient quantity issues accumulates, ’s burst intense activity focus efforts. makes development efficient avoids expensive context switching problems, cost taking longer get back . process makes good reprex particularly important might multiple months initial report start working . can’t reproduce bug, can’t fix !","code":""},{"path":"http://link.tada.science/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Romain François. Author, maintainer.","code":""},{"path":"http://link.tada.science/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"François R (2024). link: Hyperlinks. R package version 0.0.0.9000, http://tada.science/link/, https://github.com/tadascience/link.","code":"@Manual{, title = {link: Hyperlinks}, author = {Romain François}, year = {2024}, note = {R package version 0.0.0.9000, http://tada.science/link/}, url = {https://github.com/tadascience/link}, }"},{"path":"http://link.tada.science/index.html","id":"link-","dir":"","previous_headings":"","what":"Hyperlinks","title":"Hyperlinks","text":"goal link help blog authors include links prose.","code":""},{"path":"http://link.tada.science/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Hyperlinks","text":"can install development version link like :","code":"pak::pak(\"tadascience/link\")"},{"path":"http://link.tada.science/index.html","id":"example","dir":"","previous_headings":"","what":"Example","title":"Hyperlinks","text":"basic example shows solve common problem:","code":"link::to(dplyr::mutate) #> dplyr::mutate()<\/a> link::to(package = \"dplyr\") #> dplyr<\/a> link::to(\"gather\", package = \"tidyr\") #> tidyr::gather()<\/a>"}] +[{"path":[]},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement codeofconduct@posit.co. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"http://link.tada.science/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired [Mozilla’s code conduct enforcement ladder][https://github.com/mozilla/inclusion]. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"http://link.tada.science/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to link","title":"Contributing to link","text":"outlines propose change link. detailed discussion contributing tidyverse packages, please see development contributing guide code review principles.","code":""},{"path":"http://link.tada.science/CONTRIBUTING.html","id":"fixing-typos","dir":"","previous_headings":"","what":"Fixing typos","title":"Contributing to link","text":"can fix typos, spelling mistakes, grammatical errors documentation directly using GitHub web interface, long changes made source file. generally means ’ll need edit roxygen2 comments .R, .Rd file. can find .R file generates .Rd reading comment first line.","code":""},{"path":"http://link.tada.science/CONTRIBUTING.html","id":"bigger-changes","dir":"","previous_headings":"","what":"Bigger changes","title":"Contributing to link","text":"want make bigger change, ’s good idea first file issue make sure someone team agrees ’s needed. ’ve found bug, please file issue illustrates bug minimal reprex (also help write unit test, needed). See guide create great issue advice.","code":""},{"path":"http://link.tada.science/CONTRIBUTING.html","id":"pull-request-process","dir":"","previous_headings":"Bigger changes","what":"Pull request process","title":"Contributing to link","text":"Fork package clone onto computer. haven’t done , recommend using usethis::create_from_github(\"tadascience/link\", fork = TRUE). Install development dependencies devtools::install_dev_deps(), make sure package passes R CMD check running devtools::check(). R CMD check doesn’t pass cleanly, ’s good idea ask help continuing. Create Git branch pull request (PR). recommend using usethis::pr_init(\"brief-description--change\"). Make changes, commit git, create PR running usethis::pr_push(), following prompts browser. title PR briefly describe change. body PR contain Fixes #issue-number. user-facing changes, add bullet top NEWS.md (.e. just first header). Follow style described https://style.tidyverse.org/news.html.","code":""},{"path":"http://link.tada.science/CONTRIBUTING.html","id":"code-style","dir":"","previous_headings":"Bigger changes","what":"Code style","title":"Contributing to link","text":"New code follow tidyverse style guide. can use styler package apply styles, please don’t restyle code nothing PR. use roxygen2, Markdown syntax, documentation. use testthat unit tests. Contributions test cases included easier accept.","code":""},{"path":"http://link.tada.science/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contributing to link","text":"Please note link project released Contributor Code Conduct. contributing project agree abide terms.","code":""},{"path":"http://link.tada.science/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 tada⬢science Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"http://link.tada.science/SUPPORT.html","id":null,"dir":"","previous_headings":"","what":"Getting help with link","title":"Getting help with link","text":"Thanks using link! filing issue, places explore pieces put together make process smooth possible.","code":""},{"path":"http://link.tada.science/SUPPORT.html","id":"make-a-reprex","dir":"","previous_headings":"","what":"Make a reprex","title":"Getting help with link","text":"Start making minimal reproducible example using reprex package. haven’t heard used reprex , ’re treat! Seriously, reprex make R-question-asking endeavors easier (pretty insane ROI five ten minutes ’ll take learn ’s ). additional reprex pointers, check Get help! section tidyverse site.","code":""},{"path":"http://link.tada.science/SUPPORT.html","id":"where-to-ask","dir":"","previous_headings":"","what":"Where to ask?","title":"Getting help with link","text":"Armed reprex, next step figure ask. ’s question: start community.rstudio.com, /StackOverflow. people answer questions. ’s bug: ’re right place, file issue. ’re sure: let community help figure ! problem bug feature request, can easily return report . opening new issue, sure search issues pull requests make sure bug hasn’t reported /already fixed development version. default, search pre-populated :issue :open. can edit qualifiers (e.g. :pr, :closed) needed. example, ’d simply remove :open search issues repo, open closed.","code":""},{"path":"http://link.tada.science/SUPPORT.html","id":"what-happens-next","dir":"","previous_headings":"","what":"What happens next?","title":"Getting help with link","text":"efficient possible, development tidyverse packages tends bursty, shouldn’t worry don’t get immediate response. Typically don’t look repo sufficient quantity issues accumulates, ’s burst intense activity focus efforts. makes development efficient avoids expensive context switching problems, cost taking longer get back . process makes good reprex particularly important might multiple months initial report start working . can’t reproduce bug, can’t fix !","code":""},{"path":"http://link.tada.science/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Romain François. Author, maintainer.","code":""},{"path":"http://link.tada.science/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"François R (2024). link: Hyperlinks. R package version 0.0.0.9000, http://tada.science/link/, https://github.com/tadascience/link.","code":"@Manual{, title = {link: Hyperlinks}, author = {Romain François}, year = {2024}, note = {R package version 0.0.0.9000, http://tada.science/link/}, url = {https://github.com/tadascience/link}, }"},{"path":"http://link.tada.science/index.html","id":"link-","dir":"","previous_headings":"","what":"Hyperlinks","title":"Hyperlinks","text":"goal link help blog authors include links prose.","code":""},{"path":"http://link.tada.science/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Hyperlinks","text":"can install development version link like :","code":"pak::pak(\"tadascience/link\")"},{"path":"http://link.tada.science/index.html","id":"example","dir":"","previous_headings":"","what":"Example","title":"Hyperlinks","text":"basic example shows solve common problem:","code":"link::to(dplyr::mutate) #> dplyr::mutate()<\/a> link::to(package = \"dplyr\") #> dplyr<\/a> link::to(\"gather\", package = \"tidyr\") #> tidyr::gather()<\/a>"},{"path":"http://link.tada.science/reference/to.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a link to a function or a package — to","title":"Create a link to a function or a package — to","text":"Create link function package","code":""},{"path":"http://link.tada.science/reference/to.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a link to a function or a package — to","text":"","code":"to(topic, package)"},{"path":"http://link.tada.science/reference/to.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a link to a function or a package — to","text":"topic topic package package","code":""},{"path":"http://link.tada.science/reference/to.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a link to a function or a package — to","text":"","code":"link::to #> function (topic, package) #> { #> if (missing(topic)) { #> if (missing(package) || !is_string(package)) { #> cli_abort(\"{.arg package} must be a single string\") #> } #> link(downlit::href_package(package), package) #> } #> else { #> if (!missing(package) && is_string(package)) { #> text <- glue::glue(\"{package}::{topic}()\") #> url <- downlit::href_topic(topic, package = package) #> if (is.na(url)) { #> cli_abort(\"Can't find link for {text}\") #> } #> link(url, text) #> } #> else { #> topic <- enexpr(topic) #> if (!is_call(topic, \"::\")) { #> cli_abort(\"{.arg topic} must be of the form ::\") #> } #> package <- as.character(topic[[2]]) #> topic <- as.character(topic[[3]]) #> text <- glue::glue(\"{package}::{topic}()\") #> link(downlit::href_topic(topic, package = package), #> text) #> } #> } #> } #> #> if (FALSE) { link::to(dplyr::summarise) link::to(package = \"dplyr\") link::to(\"gather\", package = \"tidyr\") }"}] diff --git a/sitemap.xml b/sitemap.xml index 7a82579..f4762a6 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -27,4 +27,7 @@ http://link.tada.science/reference/index.html + + http://link.tada.science/reference/to.html +