Skip to content

Commit 848ebfc

Browse files
small docstring tweaks
1 parent acdb2ec commit 848ebfc

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

src/maxnet_function.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
maxnet(
3-
presences, predictors;
3+
p_a, X;
44
features, regularization_multiplier, regularization_function,
55
addsamplestobackground, weight_factor,
66
kw...
@@ -9,8 +9,8 @@
99
Fit a model using the maxnet algorithm.
1010
1111
# Arguments
12-
- `presences`: A `BitVector` where presences are `true` and background samples are `false`
13-
- `predictors`: A Tables.jl-compatible table of predictors. Categorical predictors should be `CategoricalVector`s
12+
- `p_a`: A `BitVector` where presences are `true` and background samples are `false`
13+
- `X`: A Tables.jl-compatible table of predictors. Categorical predictors should be `CategoricalVector`s
1414
1515
# Keywords
1616
- `features`: Either a `Vector` of `AbstractFeatureClass` to be used in the model,

src/predict.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
"""
2-
predict(m, x; link, clamp)
2+
predict(m, X; link, clamp)
33
44
Use a maxnet model to predict on new data.
55
66
# Arguments
77
- `m`: a MaxnetModel as returned by `maxnet`
8-
- `x`: a `Tables.jl`-compatible table of predictors. All columns that were used to fit `m` should be present in `x`
8+
- `X`: a `Tables.jl`-compatible table of predictors. All columns that were used to fit `m` should be present in `X`
99
1010
# Keywords
1111
- `link`: the link function used. Defaults to CloglogLink(), which is the default on the Maxent Java appliation since version 4.3.

0 commit comments

Comments
 (0)