Skip to content

Commit 12abede

Browse files
committed
start roxygen2
1 parent ad8e47f commit 12abede

File tree

6 files changed

+219
-57
lines changed

6 files changed

+219
-57
lines changed

DESCRIPTION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,4 @@ License: GPL-2
3333
LazyData: yes
3434
URL: https://github.com/RobinHankin/stokes, https://robinhankin.github.io/stokes/
3535
BugReports: https://github.com/RobinHankin/stokes/issues
36+
RoxygenNote: 7.3.2

NAMESPACE

Lines changed: 92 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,98 @@
1-
exportPattern("^[[:alpha:]]+")
1+
# Generated by roxygen2: do not edit by hand
2+
3+
S3method("coeffs<-",kform)
4+
S3method("coeffs<-",ktensor)
5+
S3method("coeffs<-",spray)
6+
S3method(Ops,kform)
7+
S3method(Ops,ktensor)
8+
S3method(as.function,kform)
9+
S3method(as.function,ktensor)
10+
S3method(lose,kform)
11+
S3method(lose,ktensor)
12+
S3method(print,kform)
13+
S3method(print,ktensor)
14+
S3method(print,summary.kform)
15+
S3method(print,summary.ktensor)
16+
S3method(summary,kform)
17+
S3method(summary,ktensor)
18+
S3method(zap,kform)
19+
S3method(zap,ktensor)
20+
export("%X%")
21+
export("%^%")
222
export("0form")
323
export("0tensor")
4-
export("%^%")
5-
export("%X%")
6-
7-
importFrom("spray","spray")
8-
importFrom("spray","as.spray")
9-
importFrom("spray","index")
10-
importFrom("spray","coeffs")
11-
importFrom("spray","coeffs<-")
12-
importFrom("spray","is.spray")
13-
importFrom("spray","arity")
14-
importFrom("spray","is.zero")
15-
importFrom("spray","spraycross")
16-
importFrom("spray","zero")
17-
24+
export("coeffs<-")
25+
export(Alt)
26+
export(as.1form)
27+
export(as.kform)
28+
export(as.ktensor)
29+
export(as.spray)
30+
export(as.symbolic)
31+
export(coeffs)
32+
export(consolidate)
33+
export(contract)
34+
export(contract_elementary)
35+
export(d)
36+
export(discard)
37+
export(dovs)
38+
export(e)
39+
export(grad)
40+
export(hodge)
41+
export(include_perms)
42+
export(inner)
43+
export(is.empty)
44+
export(is.kform)
45+
export(is.ktensor)
46+
export(is.scalar)
47+
export(is.volume)
48+
export(is.zero)
49+
export(issmall)
50+
export(keep)
51+
export(kform)
52+
export(kform_basis)
53+
export(kform_general)
54+
export(kform_to_ktensor)
55+
export(kill_trivial_rows)
56+
export(kinner)
57+
export(ktensor)
58+
export(lose)
59+
export(nterms)
60+
export(phi)
61+
export(pullback)
62+
export(rform)
63+
export(rformm)
64+
export(rformmm)
65+
export(rtensor)
66+
export(scalar)
67+
export(spray)
68+
export(stretch)
69+
export(tensorprod)
70+
export(tensorprod2)
71+
export(vcp3)
72+
export(vector_cross_product)
73+
export(volume)
74+
export(wedge)
75+
export(wedge2)
76+
export(zap)
77+
export(zeroform)
78+
export(zerotensor)
79+
importFrom(disordR,consistent)
80+
importFrom(disordR,drop)
81+
importFrom(disordR,elements)
82+
importFrom(disordR,hash)
83+
importFrom(disordR,is.disord)
84+
importFrom(methods,new)
1885
importFrom(partitions,blockparts)
19-
2086
importFrom(permutations,allperms)
21-
importFrom(permutations,sgn)
22-
importFrom(permutations,word)
2387
importFrom(permutations,as.word)
2488
importFrom(permutations,is.id)
25-
26-
importFrom(methods, new) # not needed but is included to suppress a pointless R CMD check warning
27-
28-
importFrom(disordR,elements)
29-
importFrom(disordR,is.disord)
30-
importFrom(disordR,hash)
31-
importFrom(disordR,consistent)
32-
importFrom(disordR,drop)
33-
34-
importFrom("stats", "runif")
35-
36-
S3method("as.function",ktensor)
37-
S3method("as.function",kform)
38-
S3method(Ops,kform)
39-
S3method(Ops,ktensor)
40-
S3method("lose",kform)
41-
S3method("lose",ktensor)
42-
S3method("zap",kform)
43-
S3method("zap",ktensor)
44-
45-
S3method("print",kform)
46-
S3method("print",ktensor)
47-
48-
S3method("coeffs<-",spray)
49-
S3method("coeffs<-",kform)
50-
S3method("coeffs<-",ktensor)
51-
52-
S3method("summary",kform)
53-
S3method("print",summary.kform)
54-
S3method("summary",ktensor)
55-
S3method("print",summary.ktensor)
56-
89+
importFrom(permutations,sgn)
90+
importFrom(permutations,word)
91+
importFrom(spray,"coeffs<-")
92+
importFrom(spray,arity)
93+
importFrom(spray,index)
94+
importFrom(spray,is.spray)
95+
importFrom(spray,is.zero)
96+
importFrom(spray,spraycross)
97+
importFrom(spray,zero)
98+
importFrom(stats,runif)

NEWS.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
# stokes 1.2-4
2+
3+
- roxygen2 used for NAMESPACE
4+
- minor documentation improvements
5+
- selective inclusion of vignettes for CRAN submission
6+
17
# stokes 1.2-3
28

39
- consistentification of rform() and rtensor()
@@ -9,7 +15,6 @@
915
- new vignette on tensor products
1016

1117

12-
1318
# stokes 1.2-1
1419

1520
- edge-cases for `vector_cross_product()`, now works with a single 2D vector

0 commit comments

Comments
 (0)