orderly_description: Describe the current packet
In orderly: Lightweight Reproducible Reporting
orderly_description R Documentation
Describe the current packet
Description
Describe the current packet
Usage
orderly_description(display = NULL, long = NULL, custom = NULL)
Arguments
display
A friendly name for the report; this will be
displayed in some locations of the web interface, packit. If
given, it must be a scalar character.
long
A longer description of the report. If given,
it must be a scalar character.
custom
Any additional metadata. If given, it must be a named
list, with all elements being scalar atomics (character, number,
logical).
Value
Undefined
Examples
# An example in context within the orderly examples:
orderly_example_show("data")
orderly documentation built on Jan. 24, 2026, 1:07 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| orderly_description | R Documentation |
Describe the current packet
Description
Describe the current packet
Usage
orderly_description(display = NULL, long = NULL, custom = NULL)
Arguments
display |
A friendly name for the report; this will be displayed in some locations of the web interface, packit. If given, it must be a scalar character. |
long |
A longer description of the report. If given, it must be a scalar character. |
custom |
Any additional metadata. If given, it must be a named list, with all elements being scalar atomics (character, number, logical). |
Value
Undefined
Examples
# An example in context within the orderly examples:
orderly_example_show("data")
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.