diff --git a/docs/authors.html b/docs/authors.html index 2112e0b..3159c4c 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -114,6 +114,10 @@

Authors

Joe Thorley. Author, maintainer. ORCID

+
  • +

    Ayla Pearson. Contributor. ORCID +

    +
  • Poisson Consulting. Copyright holder, funder.

    diff --git a/docs/index.html b/docs/index.html index f24ded7..c85d230 100644 --- a/docs/index.html +++ b/docs/index.html @@ -278,6 +278,7 @@

    Developers

    diff --git a/docs/reference/as.term.html b/docs/reference/as.term.html index e4541e2..e62d66b 100644 --- a/docs/reference/as.term.html +++ b/docs/reference/as.term.html @@ -133,7 +133,7 @@

    Arg x -

    The object to coerce.

    +

    The object.

    ... @@ -145,7 +145,7 @@

    Arg name -

    A string of the name for the parameter.

    +

    A string specifying the name of the parameter.

    diff --git a/docs/reference/complete_terms.html b/docs/reference/complete_terms.html index db2c7aa..504affe 100644 --- a/docs/reference/complete_terms.html +++ b/docs/reference/complete_terms.html @@ -127,11 +127,11 @@

    Arg x -

    An R object.

    +

    The object.

    ... -

    Unused

    +

    Unused.

    diff --git a/docs/reference/consistent_term.html b/docs/reference/consistent_term.html index c7d1fbf..39c7853 100644 --- a/docs/reference/consistent_term.html +++ b/docs/reference/consistent_term.html @@ -124,7 +124,7 @@

    Arg x -

    A term vector.

    +

    The object.

    diff --git a/docs/reference/dims.html b/docs/reference/dims.html index 79e2b2a..35b2f5f 100644 --- a/docs/reference/dims.html +++ b/docs/reference/dims.html @@ -130,11 +130,11 @@

    Arg x -

    An R object.

    +

    The object.

    ... -

    Unused

    +

    Unused.

    diff --git a/docs/reference/index.html b/docs/reference/index.html index 7154822..320fed2 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -210,6 +210,12 @@

    params

    + +

    Parameter Descriptions for term Functions

    + +

    parameters() `pararameters<-`() set_parameters() pars() `pars<-`() set_pars()

    diff --git a/docs/reference/is.incomplete_terms.html b/docs/reference/is.incomplete_terms.html index 653278e..deb5617 100644 --- a/docs/reference/is.incomplete_terms.html +++ b/docs/reference/is.incomplete_terms.html @@ -127,11 +127,11 @@

    Arg x -

    An object.

    +

    The object.

    ... -

    Unused

    +

    Unused.

    diff --git a/docs/reference/is.inconsistent_terms.html b/docs/reference/is.inconsistent_terms.html index 6ea52fc..3400e4c 100644 --- a/docs/reference/is.inconsistent_terms.html +++ b/docs/reference/is.inconsistent_terms.html @@ -127,11 +127,11 @@

    Arg x -

    An object.

    +

    The object.

    ... -

    Unused

    +

    Unused.

    diff --git a/docs/reference/is.term.html b/docs/reference/is.term.html index 3e34fdf..e5dc54b 100644 --- a/docs/reference/is.term.html +++ b/docs/reference/is.term.html @@ -124,7 +124,7 @@

    Arg x -

    The object to test.

    +

    The object.

    diff --git a/docs/reference/ndims.html b/docs/reference/ndims.html index 10609cc..e60dc2e 100644 --- a/docs/reference/ndims.html +++ b/docs/reference/ndims.html @@ -133,11 +133,11 @@

    Arg x -

    An R object.

    +

    The object.

    ... -

    Unused

    +

    Unused.

    diff --git a/docs/reference/npars.html b/docs/reference/npars.html index a3fb511..54fce3c 100644 --- a/docs/reference/npars.html +++ b/docs/reference/npars.html @@ -127,7 +127,7 @@

    Arg x -

    An R object.

    +

    The object.

    ... diff --git a/docs/reference/npdims.html b/docs/reference/npdims.html index 3e09823..3c68242 100644 --- a/docs/reference/npdims.html +++ b/docs/reference/npdims.html @@ -135,8 +135,7 @@

    Arg terms -

    A flag specifying whether to get the number of dimensions for each -term element.

    +

    A flag specifying whether to get the number of dimensions for each term element.

    diff --git a/docs/reference/params.html b/docs/reference/params.html new file mode 100644 index 0000000..4ad486d --- /dev/null +++ b/docs/reference/params.html @@ -0,0 +1,188 @@ + + + + + + + + +Parameter Descriptions for term Functions — params • term + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Parameter Descriptions for term Functions

    +
    + + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    x

    The object.

    name

    A string specifying the name of the parameter.

    ...

    Unused.

    repair

    A flag specifying whether to repair terms.

    select

    A character vector of the names of the parameters to include in the subsetted object.

    value

    A character vector of the new parameter names.

    pars

    A character vector of the new parameter names.

    incomparables

    Ignored.

    + + +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/pars.html b/docs/reference/pars.html index 79e0ce0..2b142b4 100644 --- a/docs/reference/pars.html +++ b/docs/reference/pars.html @@ -137,7 +137,7 @@

    Arg x -

    An R object.

    +

    The object.

    ... @@ -160,7 +160,7 @@

    Arg terms

    A flag specifying whether to return the parameter name -for each term element.

    +for each term element

    diff --git a/docs/reference/pdims.html b/docs/reference/pdims.html index 8d9a49e..cbe9d9b 100644 --- a/docs/reference/pdims.html +++ b/docs/reference/pdims.html @@ -126,7 +126,7 @@

    Arg x -

    The object

    +

    The object.

    ... diff --git a/docs/reference/repair_terms.html b/docs/reference/repair_terms.html index 22b6b68..fcdb47b 100644 --- a/docs/reference/repair_terms.html +++ b/docs/reference/repair_terms.html @@ -124,7 +124,7 @@

    Arg x -

    A term vector.

    +

    The object.

    diff --git a/docs/reference/subset.term.html b/docs/reference/subset.term.html index f62e8e3..555e55d 100644 --- a/docs/reference/subset.term.html +++ b/docs/reference/subset.term.html @@ -125,7 +125,7 @@

    Arg x -

    A term vector to be subsetted.

    +

    The object.

    select diff --git a/docs/reference/term.html b/docs/reference/term.html index 6ceda40..2c25f0e 100644 --- a/docs/reference/term.html +++ b/docs/reference/term.html @@ -127,8 +127,7 @@

    Arg x -

    An integer vector of the object dimensions -or a named list of the parameter's dimensions.

    +

    An integer vector of the object dimensions or a named list of the parameter's dimensions.

    ... diff --git a/docs/reference/tindex.html b/docs/reference/tindex.html index e76ebb0..6c06dd7 100644 --- a/docs/reference/tindex.html +++ b/docs/reference/tindex.html @@ -129,7 +129,7 @@

    Arg x -

    The object

    +

    The object.

    ... diff --git a/docs/reference/unique.term.html b/docs/reference/unique.term.html index f90429c..355d1a5 100644 --- a/docs/reference/unique.term.html +++ b/docs/reference/unique.term.html @@ -125,7 +125,7 @@

    Arg x -

    A term vector.

    +

    The object.

    incomparables diff --git a/docs/reference/valid_term.html b/docs/reference/valid_term.html index 414c715..85cd12f 100644 --- a/docs/reference/valid_term.html +++ b/docs/reference/valid_term.html @@ -124,7 +124,7 @@

    Arg x -

    A term vector.

    +

    The object.