diff --git a/index.html b/index.html index 90ba107..3c437d7 100644 --- a/index.html +++ b/index.html @@ -51,6 +51,14 @@

The goal of repositoryr is to provide a step by step guide to creating a R package repository.

+

Selecting a package name +

+

To find suggestions on valid package names use available::suggest(text="description of what the package does"). You can also check whether the package name is available using available::available("pkgname").

+
USing available package

Alternatively, you can use pak::pkg_name_check("healthgpsrvis", dictionaries = NULL).

+
+

Installation

You can install the development version of repositoryr from GitHub with:

diff --git a/pkgdown.yml b/pkgdown.yml index aa96706..2c68590 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 3.1.11 pkgdown: 2.1.1 pkgdown_sha: ~ articles: {} -last_built: 2024-10-01T10:21Z +last_built: 2024-10-01T11:55Z urls: reference: https://imperialcollegelondon.github.io/repositoryr/reference article: https://imperialcollegelondon.github.io/repositoryr/articles diff --git a/search.json b/search.json index 34ed920..74deca0 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":"https://imperialcollegelondon.github.io/repositoryr/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"package maintainer. Maintainer.","code":""},{"path":"https://imperialcollegelondon.github.io/repositoryr/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Ww (2024). repositoryr: Package (Title Case). R package version 0.1.0, https://imperialcollegelondon.github.io/repositoryr/.","code":"@Manual{, title = {repositoryr: What the Package Does (Title Case)}, author = {Who wrote it}, year = {2024}, note = {R package version 0.1.0}, url = {https://imperialcollegelondon.github.io/repositoryr/}, }"},{"path":"https://imperialcollegelondon.github.io/repositoryr/index.html","id":"repositoryr","dir":"","previous_headings":"","what":"What the Package Does (Title Case)","title":"What the Package Does (Title Case)","text":"goal repositoryr provide step step guide creating R package repository.","code":""},{"path":"https://imperialcollegelondon.github.io/repositoryr/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"What the Package Does (Title Case)","text":"can install development version repositoryr GitHub :","code":"# install.packages(\"pak\") pak::pak(\"ImperialCollegeLondon/repositoryr\")"},{"path":"https://imperialcollegelondon.github.io/repositoryr/index.html","id":"example","dir":"","previous_headings":"","what":"Example","title":"What the Package Does (Title Case)","text":"basic example shows solve common problem: special using README.Rmd instead just README.md? can include R chunks like : ’ll still need render README.Rmd regularly, keep README.md --date. devtools::build_readme() handy . can also embed plots, example: case, don’t forget commit push resulting figure files, display GitHub CRAN.","code":"library(repositoryr) ## basic example code summary(cars) #> speed dist #> Min. : 4.0 Min. : 2.00 #> 1st Qu.:12.0 1st Qu.: 26.00 #> Median :15.0 Median : 36.00 #> Mean :15.4 Mean : 42.98 #> 3rd Qu.:19.0 3rd Qu.: 56.00 #> Max. :25.0 Max. :120.00"},{"path":"https://imperialcollegelondon.github.io/repositoryr/reference/hello.html","id":null,"dir":"Reference","previous_headings":"","what":"Hello, World! — hello","title":"Hello, World! — hello","text":"Prints 'Hello, world!'.","code":""},{"path":"https://imperialcollegelondon.github.io/repositoryr/reference/hello.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Hello, World! — hello","text":"","code":"hello()"},{"path":"https://imperialcollegelondon.github.io/repositoryr/reference/hello.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Hello, World! — hello","text":"","code":"hello() #> [1] \"Hello, world!\""}] +[{"path":"https://imperialcollegelondon.github.io/repositoryr/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"package maintainer. Maintainer.","code":""},{"path":"https://imperialcollegelondon.github.io/repositoryr/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Ww (2024). repositoryr: Package (Title Case). R package version 0.1.0, https://imperialcollegelondon.github.io/repositoryr/.","code":"@Manual{, title = {repositoryr: What the Package Does (Title Case)}, author = {Who wrote it}, year = {2024}, note = {R package version 0.1.0}, url = {https://imperialcollegelondon.github.io/repositoryr/}, }"},{"path":"https://imperialcollegelondon.github.io/repositoryr/index.html","id":"repositoryr","dir":"","previous_headings":"","what":"What the Package Does (Title Case)","title":"What the Package Does (Title Case)","text":"goal repositoryr provide step step guide creating R package repository.","code":""},{"path":"https://imperialcollegelondon.github.io/repositoryr/index.html","id":"selecting-a-package-name","dir":"","previous_headings":"","what":"Selecting a package name","title":"What the Package Does (Title Case)","text":"find suggestions valid package names use available::suggest(text=\"description package \"). can also check whether package name available using available::available(\"pkgname\"). USing available package Alternatively, can use pak::pkg_name_check(\"healthgpsrvis\", dictionaries = NULL).","code":""},{"path":"https://imperialcollegelondon.github.io/repositoryr/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"What the Package Does (Title Case)","text":"can install development version repositoryr GitHub :","code":"# install.packages(\"pak\") pak::pak(\"ImperialCollegeLondon/repositoryr\")"},{"path":"https://imperialcollegelondon.github.io/repositoryr/index.html","id":"example","dir":"","previous_headings":"","what":"Example","title":"What the Package Does (Title Case)","text":"basic example shows solve common problem: special using README.Rmd instead just README.md? can include R chunks like : ’ll still need render README.Rmd regularly, keep README.md --date. devtools::build_readme() handy . can also embed plots, example: case, don’t forget commit push resulting figure files, display GitHub CRAN.","code":"library(repositoryr) ## basic example code summary(cars) #> speed dist #> Min. : 4.0 Min. : 2.00 #> 1st Qu.:12.0 1st Qu.: 26.00 #> Median :15.0 Median : 36.00 #> Mean :15.4 Mean : 42.98 #> 3rd Qu.:19.0 3rd Qu.: 56.00 #> Max. :25.0 Max. :120.00"},{"path":"https://imperialcollegelondon.github.io/repositoryr/reference/hello.html","id":null,"dir":"Reference","previous_headings":"","what":"Hello, World! — hello","title":"Hello, World! — hello","text":"Prints 'Hello, world!'.","code":""},{"path":"https://imperialcollegelondon.github.io/repositoryr/reference/hello.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Hello, World! — hello","text":"","code":"hello()"},{"path":"https://imperialcollegelondon.github.io/repositoryr/reference/hello.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Hello, World! — hello","text":"","code":"hello() #> [1] \"Hello, world!\""}]