Skip to content

Commit 639772c

Browse files
committed
Updated pkgdown site + workflow
1 parent 6461f42 commit 639772c

4 files changed

Lines changed: 59 additions & 13 deletions

File tree

.github/workflows/generate-workspace.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ jobs:
3737
uses: actions/upload-artifact@v4
3838
with:
3939
name: iscam-workspace
40-
path: ISCAM.RData
40+
path: inst/extdata/ISCAM.RData

DESCRIPTION

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Title: Companion to the Book "Investigating Statistical Concepts,
33
Applications, and Methods"
44
Version: 0.0.0.9000
55
Authors@R: c(
6-
person("Beth", "Chance", , "bchance@calpoly.edu", role = c("cre", "cph")),
6+
person("Beth", "Chance", , "bchance@calpoly.edu", role = c("cre", "aut", "cph")),
77
person("Visruth", "Srimath Kandali", , "visruth@gmail.com", role = "aut",
88
comment = c(ORCID = "0009-0005-9097-0688"))
99
)
@@ -16,7 +16,7 @@ Description: Introductory statistics methods to accompany "Investigating
1616
package is designed to be used in an educational setting alongside the
1717
ISCAM textbook.
1818
License: MIT + file LICENSE
19-
URL: https://visruthsk.github.io/ISCAM/
19+
URL: https://iscam4.github.io/ISCAM
2020
Depends:
2121
R (>= 2.10)
2222
Imports:

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,32 @@ ISCAM
77
<!-- badges: end -->
88

99
```r
10-
# install.packages("pak") # uncomment this line and run it *once*
11-
10+
# install.packages("pak") # uncomment and run this line *once*
1211
# options(use_bioconductor = FALSE) # do this is you get some issues running the next line when connected to the eduroam network
1312
pak::pkg_install("ISCAM4/ISCAM") # this installs or updates the package
1413

15-
# if {pak} doesn't work, try the following two commands
14+
# if {pak} doesn't work, uncomment and run the following two commands
1615
#install.packages("remotes")
1716
#remotes::install_github("ISCAM4/ISCAM")
1817

19-
library(ISCAM) # this loads the package. You need to do this every time you want to use ISCAM functions
18+
# the following loads the package. You need to do this every time you want to use ISCAM functions
19+
library(ISCAM)
2020
```
2121

2222
This package collates and presents functions for ISCAM alongside some data to be used alongside the textbook.
2323

24-
If you don't know how a function e.g. `EXAMPLE()` works, you can write `?EXAMPLE` in the console to get help. You can also find it on [the website](https://iscam4.github.io/ISCAM/index.html). Also look to the textbook/Canvas/homework to see how the function is used.
24+
If you don't know how a function e.g. `EXAMPLE()` works, you can write `?EXAMPLE` in the console to get help. You can also find it on [the website](https://iscam4.github.io/ISCAM/reference/index.html). Also look to the textbook/Canvas/homework to see how the function is used.
25+
26+
You can load the workspace by running
2527

26-
You can load the workspace by using `load(url("https://github.com/ISCAM4/ISCAM/raw/refs/heads/master/inst/extdata/ISCAM.RData"))`
28+
```r
29+
load(url("https://github.com/ISCAM4/ISCAM/raw/refs/heads/master/inst/extdata/ISCAM.RData"))
30+
```
31+
<!-- ```r
32+
load(url("http://www.rossmanchance.com/iscam4/ISCAM.RData"))
33+
``` -->
2734

28-
Old Workspace: `load(url("http://www.rossmanchance.com/iscam3/ISCAM.RData"))`
35+
You can use the old workspace at `load(url("http://www.rossmanchance.com/iscam3/ISCAM.RData"))`
2936

3037
<!--
3138
TODO:

_pkgdown.yml

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,48 @@
1-
url: https://visruthsk.github.io/ISCAM/
1+
url: https://iscam4.github.io/ISCAM/
22

33
destination: docs
44

55
template:
66
bootstrap: 5
77

8-
development:
9-
mode: auto
8+
search:
9+
exclude: ['news/index.html']
10+
11+
navbar:
12+
structure:
13+
left: [home, functions, datasets, news]
14+
right: [search, github]
15+
components:
16+
home:
17+
icon: fa-home fa-lg
18+
aria-label: home
19+
href: index.html
20+
functions:
21+
text: "Functions"
22+
href: reference/index.html
23+
datasets:
24+
text: "Datasets"
25+
href: reference/index.html#datasets
26+
news:
27+
text: "News"
28+
href: news/index.html
29+
github:
30+
icon: fa-github fa-lg
31+
aria-label: github
32+
href: https://github.com/ISCAM4/ISCAM
33+
34+
reference:
35+
- title: "Functions"
36+
desc: "These are the main functions for working with the ISCAM package."
37+
contents:
38+
- starts_with("iscam")
39+
- title: "Datasets"
40+
desc: "Datasets included in the package."
41+
contents:
42+
- has_keyword("dataset")
43+
44+
# articles:
45+
# - title: "Getting Started"
46+
# navbar: "Getting Started"
47+
# contents:
48+
# - "your-vignette-filename"

0 commit comments

Comments
 (0)