Skip to content

Commit bf33cc4

Browse files
committed
set up actions
1 parent 6a63475 commit bf33cc4

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

README.Rmd

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
output: github_document
3+
---
4+
5+
<!-- README.md is generated from README.Rmd. Please edit that file -->
6+
7+
```{r, include = FALSE}
8+
knitr::opts_chunk$set(
9+
collapse = TRUE,
10+
comment = "#>",
11+
fig.path = "man/figures/README-",
12+
out.width = "100%"
13+
)
14+
```
15+
16+
# fda
17+
18+
<!-- badges: start -->
19+
[![R-CMD-check](https://github.com/JamesRamsay5/fda/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/JamesRamsay5/fda/actions/workflows/R-CMD-check.yaml)
20+
<!-- badges: end -->
21+
22+
The goal of fda is to ...
23+
24+
## Installation
25+
26+
You can install the development version of fda from [GitHub](https://github.com/) with:
27+
28+
``` r
29+
# install.packages("devtools")
30+
devtools::install_github("JamesRamsay5/fda")
31+
```
32+
33+
## Example
34+
35+
This is a basic example which shows you how to solve a common problem:
36+
37+
```{r example}
38+
library(fda)
39+
## basic example code
40+
```
41+
42+
What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:
43+
44+
```{r cars}
45+
summary(cars)
46+
```
47+
48+
You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date. `devtools::build_readme()` is handy for this.
49+
50+
You can also embed plots, for example:
51+
52+
```{r pressure, echo = FALSE}
53+
plot(pressure)
54+
```
55+
56+
In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.

0 commit comments

Comments
 (0)