Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
agricolamz committed Feb 25, 2023
1 parent 37140ff commit 151c3ee
Show file tree
Hide file tree
Showing 5 changed files with 300 additions and 110 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ install.packages("lingtypology")
```
… or get the development version from GitHub:
```R
install.packages("devtools")
devtools::install_github("ropensci/lingtypology")
install.packages("remotes")
remotes::install_github("ropensci/lingtypology")
```

Sometimes installation failed because of the absence of the package `crosstalk`. Just install it using command `install.packages("crosstalk")`.
Expand Down
32 changes: 0 additions & 32 deletions tests/testthat/test-ids-feature.R

This file was deleted.

4 changes: 2 additions & 2 deletions vignettes/lingtypology_intro.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
# install.packages("lingtypology", dependencies = TRUE)

## ---- eval= FALSE-------------------------------------------------------------
# install.packages("devtools")
# devtools::install_github("ropensci/lingtypology")
# install.packages("remotes")
# remotes::install_github("ropensci/lingtypology")

## -----------------------------------------------------------------------------
library(lingtypology)
Expand Down
8 changes: 5 additions & 3 deletions vignettes/lingtypology_intro.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,20 @@ vignette: >
---

### What is `lingtypology`?

The `lingtypology` package connects R with the [Glottolog database (v. 4.4)](https://glottolog.org/) and provides an additional functionality for linguistic typology. The Glottolog database contains a catalogue of the world's languages. This package helps researchers to make linguistic maps, using the philosophy of [the Cross-Linguistic Linked Data project](https://clld.org/), which is creating a uniform access to linguistic data across publications. This package is based on the [leaflet package](https://rstudio.github.io/leaflet/), so `lingtypology` is a package for interactive linguistic mapping. In addition, the package provides an ability to download data from typological databases such as WALS, AUTOTYP and others (see section 4). The functionality of this package intersects with the package [`lingtypr`](https://gitlab.com/laurabecker/lingtypr) by Laura Becker. I would like to thank Natalya Tyshkevich, Samira Verhees and Eugenya Klyagina for reading and correcting some versions of this vignette.

### 1. Installation
Since `lingtypology` is an R package, you should install [R (version >= 3.1.0)](https://www.r-project.org/) on your PC if you haven't already done so. To install the `lingtypology` package, run the following command at your R IDE, so you get the stable version from CRAN:

Since `lingtypology` is an R package, you should install [R (version >= 3.5.0)](https://www.r-project.org/) on your PC if you haven't already done so. To install the `lingtypology` package, run the following command at your R IDE, so you get the stable version from CRAN:
```{r, eval=FALSE}
install.packages("lingtypology", dependencies = TRUE)
```

You can also get the development version from GitHub:
```{r, eval= FALSE}
install.packages("devtools")
devtools::install_github("ropensci/lingtypology")
install.packages("remotes")
remotes::install_github("ropensci/lingtypology")
```

Load the package:
Expand Down
Loading

0 comments on commit 151c3ee

Please sign in to comment.