forked from oganm/5eInteractiveSheet
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
90 lines (56 loc) · 2.57 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
83
84
85
86
87
88
89
90
---
output: github_document
---
# Readme
## Online version
Online version can be found [here](https://oganm.github.io/5eInteractiveSheet/). It is less responsive than the installed version as it's running on a potato. It's been fast enough for me so far but running a local version boosts performance significantly.
## Installation
### Windows
Download and install either [this](https://github.com/oganm/5eInteractiveSheet/raw/master/sheet/RInno_installer/setup_5eInteractiveSheet.exe) file (static version) or [this](https://github.com/oganm/5eInteractiveSheet/raw/master/sheetCI/RInno_installer/setup_import5eChar.exe) one (automatically gets the latest version)
After that you should be golden.
Double click the desktop icon to run. See usage instructions [here](https://github.com/oganm/import5eChar/blob/master/interactiveSheetDocumentation.md)
You'll only be missing one minor feature: The ability to get your files directly
from googledrive without downloading them first. Alas I failed to port this to
the installer. If you really want this you can install it through the sligtly
more difficult way explained below.
### Linux/mac, Ambitious windows user
If you are on linux/mac, sorry, no exe for you. You need to install R on your own.
If you are on Windows and want to use direct import from google drive, you also
need to follow the steps here.
Instal R by following instructions below
* [Linux](https://cran.r-project.org/bin/linux/)
* [OSx](https://cran.r-project.org/bin/macosx/)
* [Windows](https://cran.r-project.org/bin/windows/base/)
After installing R open it. On the RGui, run the following commands
```r
install.packages('devtools')
devtools::install_github('oganm/import5eChar')
```
This will complete the installation. From now on you just need to do
```r
import5eChar::shinySheetAC()
```
from RGui to run the app.
### R user
I assume you have everything set up
```r
install.packages('devtools')
devtools::install_github('oganm/import5eChar')
```
to install and
```r
import5eChar::shinySheetAC()
```
to run. Note that this'll shut down your R session after closing the window.
If you don't want that to happen use `import5eChar::shinySheet()` instead.
## Updating
If you are on windows and used the static installer, uninstall your previous version, download exe and install.
If you have used the auto updating version, don't do anything.
Other's just run
```r
devtools::install_github('oganm/import5eChar')
```
again
## Using
[Here](https://github.com/oganm/import5eChar/blob/master/interactiveSheetDocumentation.md)
is a documentation of the sheet's functions