Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jrdnbradford committed Aug 14, 2024
1 parent fa2cff9 commit 90513de
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 21 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,20 +21,22 @@ network analysis.

## Installation

To install the package from CRAN:
To install the latest
[r-universe](https://ropensci.r-universe.dev/historydata) build:

``` r
install.packages("historydata")
install.packages('historydata', repos = c('https://ropensci.r-universe.dev'))
```

To install the latest
[r-universe](https://ropensci.r-universe.dev/historydata) build:
To install the package from
[CRAN](https://cran.r-project.org/package=historydata):

``` r
install.packages('historydata', repos = c('https://ropensci.r-universe.dev'))
install.packages("historydata")
```

You can install the development version from GitHub with {devtools}:
You can install the development version from
[GitHub](https://github.com/ropensci/historydata) with {devtools}:

``` r
# install.packages("devtools")
Expand All @@ -43,10 +45,12 @@ devtools::install_github("ropensci/historydata")

## Use

To list all the datasets in the package with their documentation:
See the [package index
reference](https://docs.ropensci.org/historydata/reference/index.html)
for all the datasets in the package and their documentation. You can
also use R’s builtin help:

``` r
library(historydata)
help(package = historydata)
```

Expand All @@ -66,5 +70,5 @@ head(catholic_dioceses)

## License

This project is released under the MIT License:
<http://lmullen.mit-license.org/>
This project is released under the MIT License. See
[LICENSE.md](./LICENSE.md) for details.
22 changes: 11 additions & 11 deletions README.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -28,40 +28,40 @@ These sample data sets are intended for historians learning R. They include popu

## Installation

To install the package from CRAN:

```{R install, echo=TRUE, eval=FALSE}
install.packages("historydata")
```

To install the latest [r-universe](https://ropensci.r-universe.dev/historydata) build:

```{R install-r-universe, echo=TRUE, eval=FALSE}
install.packages('historydata', repos = c('https://ropensci.r-universe.dev'))
```

You can install the development version from GitHub with {devtools}:
To install the package from [CRAN](https://cran.r-project.org/package=historydata):

```{R devtools-install, echo=TRUE, eval=FALSE}
```{R install-cran, echo=TRUE, eval=FALSE}
install.packages("historydata")
```

You can install the development version from [GitHub](https://github.com/ropensci/historydata) with {devtools}:

```{R install-github, echo=TRUE, eval=FALSE}
# install.packages("devtools")
devtools::install_github("ropensci/historydata")
```

## Use

To list all the datasets in the package with their documentation:
See the [package index reference](https://docs.ropensci.org/historydata/reference/index.html) for all the datasets in the package and their documentation. You can also use R's builtin help:

```{R help, echo=TRUE, eval=FALSE, output=FALSE}
library(historydata)
help(package = historydata)
```

To load a dataset directly into your environment:

```{R load, echo=TRUE, eval=TRUE, output=TRUE}
data(catholic_dioceses)
head(catholic_dioceses)
```

## License

This project is released under the MIT License. See [LICENSE.md](LICENSE.md) for details.
This project is released under the MIT License. See [LICENSE.md](./LICENSE.md) for details.

0 comments on commit 90513de

Please sign in to comment.