Skip to content

Commit b3e4b78

Browse files
committed
Tiny changes.
1 parent 3f80ba9 commit b3e4b78

File tree

3 files changed

+28
-25
lines changed

3 files changed

+28
-25
lines changed

README.Rmd

+5-20
Original file line numberDiff line numberDiff line change
@@ -17,27 +17,12 @@ library(badger)
1717

1818
## Package website
1919

20-
The website of the package is deployed at https://adamkocsis.github.io/icosa/
20+
The website of the package is deployed at https://adamkocsis.github.io/icosa/ using [pkgdown](https://pkgdown.r-lib.org/), which includes function references and tutorials.
2121

22+
**Installation instructions** can be found [here](https://adamkocsis.github.io/icosa/articles/icosa_1_installation.html).
2223

23-
## Installation
24-
25-
1. The stable version of the package is openly available from the CRAN servers. Just type in
26-
```
27-
`install.packages("icosa")`
28-
```
29-
30-
and the package will be installed. In case you would like to experiment with the under development versions, please take a look at the points below
31-
32-
2. If you have a compiler installed, you can install the latest version from the source tarball, with
33-
```
34-
install.packages(
35-
"https://github.com/adamkocsis/icosa/raw/master/_archive/sources/icosa_0.10.0.tar.gz",
36-
repos=NULL, type="source")
37-
```
38-
3. I will also provide binaries for Windows. If you want to, you can try them.
39-
`install.packages("https://github.com/adamkocsis/icosa/raw/master/_bin/Win_x64_x86/icosa_0.10.0.zip", repos=NULL, type="win.binary")`
40-
24+
## Change log
4125

4226
See changes at
43-
https://github.com/adamkocsis/icosa/blob/devel/inst/NEWS.md
27+
28+
https://github.com/adamkocsis/icosa/blob/devel/NEWS.md

_pkgdown.yml

+7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
url: https://adamkocsis.github.io/icosa
22
template:
3+
opengraph:
4+
image:
5+
src: man/figures/logo.png
6+
alt: The icosa sticker.
7+
twitter:
8+
creator: "@atkocsis"
9+
card: summary_large_image
310
bootstrap: 5
411
bootswatch: cosmo
512
bslib:

index.Rmd

+16-5
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,30 @@ library(badger)
1717

1818
#### Triangular and Penta-Hexagonal Grids Based on Tessellated Icosahedra
1919

20-
icosa (originally εἴκοσι) is greek for twenty, and refers to the icosahedron.
20+
icosa (originally εἴκοσι) is greek for twenty, and refers to the icosahedron. The 'icosa' extension is an implementation of icosahedral grids in three dimensions. The spherical-triangular tessellation can be set to create grids with custom resolutions. Both the primary triangular and their inverted penta-hexagonal grids can be calculated. Additional functions are provided that allow plotting of the grids and associated data, the interaction of the grids with other raster and vector objects, and treating the grids as a graphs.
2121

2222
These grids are often called icospheres, and have an important use in material design, architecture, computer graphics and chemistry.
2323

24-
## Package descriptions
24+
* * *
25+
26+
#### Similar packages
2527

26-
Employs triangular tessellation to refine icosahedra defined in 3d space. The procedures can be set to provide a grid with a custom resolution. Both the primary triangular and their inverted penta-hexagonal grids are available for implementation. Additional functions are provided to position points (latitude-longitude data) on the grids, to allow 2D and 3D plotting, use raster data and shapefiles.
28+
Implementations of similar grids are available in R with the [H3 library](https://h3geo.org/) ([h3-js](https://obrl-soil.github.io/h3jsr/)) and the [ddgridR](https://github.com/r-barnes/dggridR) libraries. These other implementations are based on hierarchical organizations of grid cells, which allows very high-resolution. In contrast, the icosa package was optimized for coarser resolutions, providing a more gradual change of cells sizes, 3D-based operations (e.g. grid rotation), and to be used in the R environment for spatially isotropic analysis - especially when it comes to latitudinal patterns. It also allows access to not only hexagonal, but triangular grids as well.
2729

2830
* * *
2931

30-
## Notes
32+
## Plans
33+
34+
#### Near
35+
36+
- Finishing vignettes in **Tutorials**
37+
- Paper about the package (long overdue)
38+
- Moving internal vector-representation from `sp` to `sf`
39+
40+
#### Distant
3141

32-
This is a beta version, and like R, comes with absolutely no warranty.
42+
- Customization of tesselation that allows tweaking of cell sizes and shapes - depending on needs
43+
- Writing a C++ library from the core functionality and porting it to Pyhton and Julia
3344

3445

3546

0 commit comments

Comments
 (0)