Skip to content

Commit 97e8cc7

Browse files
R-universe packaging
1 parent 7e0cd6a commit 97e8cc7

6 files changed

Lines changed: 52 additions & 15 deletions

File tree

.Rbuildignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
^\.github$
2+
^\.gitattributes$
23
^\.codex$
34
^\.agents$
45
^_site$

.gitattributes

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
* text=auto eol=lf
2+
3+
*.R text eol=lf
4+
*.Rmd text eol=lf
5+
*.md text eol=lf
6+
*.py text eol=lf
7+
*.json text eol=lf
8+
*.csv text eol=lf
9+
*.html text eol=lf
10+
*.yml text eol=lf
11+
*.yaml text eol=lf
12+
13+
*.png binary
14+
*.jpg binary
15+
*.jpeg binary
16+
*.gif binary
17+
*.pdf binary
18+
*.tar.gz binary
19+
20+
/analysis/generated/** linguist-generated=true
21+
/images/** linguist-generated=true

.gitignore

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,45 @@
1-
.codex/
2-
.codex
3-
41
# R session and project-local state
52
.Rhistory
63
.RData
74
.Ruserdata
85
Rplots.pdf
96
.Rproj.user/
7+
.Rproj
108
renv/library/
119
renv/staging/
10+
renv/python/
11+
renv/sandbox/
1212

13-
# Local scratch output
14-
tmp/
15-
scratch/
16-
_site/
17-
*.log
13+
# R package build/check output
1814
*.tar.gz
1915
*.Rcheck/
16+
*.Rcheck
17+
check/
18+
Meta/
19+
20+
# Local generated site and scratch output
21+
_site/
22+
*.log
23+
tmp/
24+
scratch/
25+
26+
# Codex/agent-local state
27+
.codex/
28+
.codex
29+
.agents/
30+
.agents
2031

2132
# Python environments and caches
2233
__pycache__/
2334
*.py[cod]
35+
.pytest_cache/
36+
.mypy_cache/
2437
.venv/
2538
venv/
2639
env/
2740

2841
# Local OS/editor files
2942
.DS_Store
3043
Thumbs.db
44+
.idea/
45+
.vscode/

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ install.packages("remotes")
4848
remotes::install_github("SidRichardsQuantum/Celestial_Dynamics_Iteration_Methods")
4949
```
5050

51-
After the R-universe registry has been created, install from R-universe:
51+
After R-universe has built the package, install from R-universe:
5252

5353
```r
5454
options(repos = c(
@@ -58,7 +58,7 @@ options(repos = c(
5858
install.packages("CelestialDynamicsIterationMethods")
5959
```
6060

61-
R-universe setup notes and the required registry file are in
61+
R-universe setup notes and the registry details are in
6262
[docs/R_UNIVERSE.md](docs/R_UNIVERSE.md).
6363

6464
Run all validations:

docs/R_UNIVERSE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ a separate GitHub repository under the same account.
55

66
## Registry Repository
77

8-
Create this public GitHub repository:
8+
The public R-universe registry repository is:
99

1010
```text
1111
SidRichardsQuantum/sidrichardsquantum.r-universe.dev
1212
```
1313

14-
Add a root-level `packages.json` file with:
14+
Its root-level `packages.json` file should contain:
1515

1616
```json
1717
[
@@ -22,7 +22,7 @@ Add a root-level `packages.json` file with:
2222
]
2323
```
2424

25-
Then install the R-universe GitHub app for the `SidRichardsQuantum` account:
25+
Install the R-universe GitHub app for the `SidRichardsQuantum` account:
2626

2727
```text
2828
https://github.com/apps/r-universe

docs/USAGE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ install.packages("remotes")
99
remotes::install_github("SidRichardsQuantum/Celestial_Dynamics_Iteration_Methods")
1010
```
1111

12-
After the R-universe registry has been created, install from R-universe:
12+
After R-universe has built the package, install from R-universe:
1313

1414
```r
1515
options(repos = c(
@@ -19,7 +19,7 @@ options(repos = c(
1919
install.packages("CelestialDynamicsIterationMethods")
2020
```
2121

22-
R-universe setup notes and the required registry file are in
22+
R-universe setup notes and the registry details are in
2323
[docs/R_UNIVERSE.md](R_UNIVERSE.md).
2424

2525
For source checkouts:

0 commit comments

Comments
 (0)