-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.Rmd
82 lines (63 loc) · 3.17 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# vecsymr
<!-- badges: start -->
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[](https://app.codecov.io/gh/rgayler/vecsymr?branch=main)
[](https://github.com/rgayler/vecsymr/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->
The goal of {vecsymr} is to implement Vector Symbolic Architecture (VSA)
primitives to support experimentation. It is intended to be a simple VSA
implementation (the VSA equivalent of the geneticist's fruit fly) to provide a
convenient base for experimentation. The design choices are
[my](https://www.rossgayler.com) personal preferences to support my research.
The initial emphasis is on functionality and flexibility with no specific
concern for performance.
I believe that phasor VSAs (where the vector elements are unit magnitude
complex numbers) are the best choice for basic VSAs. However, I have initially
imported functions for bipolar VSAs from
[VSA_altitude_hold](https://github.com/rgayler/VSA_altitude_hold) to provide
some code while I get the hang of writing an R package. Once the package
contains enough phasor VSA code I will probably remove the bipolar VSA code. The
phasor VSA code will probably include some extra features to support
non-negativity and experimentation with clean-up memory.
## Installation
You can install the development version of {vecsymr} from
[GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("rgayler/vecsymr")
```
There is currently no intention to put this package on CRAN. If it turns out to
be sufficiently useful and general I may try get it accepted as an
[rOpenSci](https://ropensci.org/packages/) package.
The current implementation is experimental. I expect the functional content to
evolve as I work out what I want this package to do. I also expect the API to
evolve as I work out how to make it easier to work with. If you want to do any
reproducible work with the package you will need to use something like
[{renv}](https://rstudio.github.io/renv/) to freeze the version in use.
## Ignore below here
Everything after this point is just boilerplate to be edited.
## Example
This is a basic example which shows you how to solve a common problem:
```{r example}
library(vecsymr)
## basic example code
```
## Remember
You'll still need to render `README.Rmd` regularly, to keep `README.md`
up-to-date. `devtools::build_readme()` is handy for this. You could also use
GitHub Actions to re-render `README.Rmd` every time you push. An example
workflow can be found here: <https://github.com/r-lib/actions/tree/v1/examples>.
If you create figures in the README don't forget to commit and push the
resulting figure files, so they display on GitHub.