https://github.com/statsrhian/myawesomepkg

What the Package Does (One Line, Title Case)
https://github.com/statsrhian/myawesomepkg

List: myawesomepkg

Last synced: about 2 months ago
JSON representation

What the Package Does (One Line, Title Case)

• Host: GitHub
• URL: https://github.com/statsrhian/myawesomepkg
• Owner: StatsRhian
• Created: 2024-07-11T09:55:59.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-07-11T10:06:53.000Z (6 months ago)
• Last Synced: 2024-07-12T11:32:42.305Z (6 months ago)
• Language: R
• Size: 977 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# myAwesomePkg

[![R-CMD-check](https://github.com/StatsRhian/myAwesomePkg/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/StatsRhian/myAwesomePkg/actions/workflows/R-CMD-check.yaml)

The goal of myAwesomePkg is to say hello

## Installation

You can install the development version of myAwesomePkg from [GitHub](https://github.com/) with:

``` r

# install.packages("devtools")

devtools::install_github("StatsRhian/myAwesomePkg")

```

## Example

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

```{r example}

library(myAwesomePkg)

## basic example code

```

What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:

```{r cars}

summary(cars)

```

You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date. `devtools::build_readme()` is handy for this.

You can also embed plots, for example:

```{r pressure, echo = FALSE}

plot(pressure)

```

In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.