Skip to content

Commit e1f0142

Browse files
committed
Update roxygen docs
1 parent 8cba032 commit e1f0142

6 files changed

Lines changed: 34 additions & 0 deletions

R/Profile.R

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ setClass("tiledb_profile",
1010
slots = list(ptr = "externalptr")
1111
)
1212

13+
#' Raw display of a profile object
14+
#'
15+
#' This method uses the display method provided by the underlying library.
16+
#'
17+
#' @param object A profile object
18+
#' @export
1319
setMethod(
1420
"raw_dump",
1521
signature(object = "tiledb_profile"),
@@ -58,6 +64,7 @@ tiledb_profile_remove <- function(name = NULL, dir = NULL) {
5864

5965
#' Get the name of a 'tiledb_profile' object
6066
#'
67+
#' @param profile A TileDB profile object
6168
#' @return The name of the 'tiledb_profile' object
6269
#' @export
6370
tiledb_profile_name <- function(profile) {
@@ -68,6 +75,7 @@ tiledb_profile_name <- function(profile) {
6875

6976
#' Get the directory of a 'tiledb_profile' object
7077
#'
78+
#' @param profile A TileDB profile object
7179
#' @return The directory of the 'tiledb_profile' object
7280
#' @export
7381
tiledb_profile_dir <- function(profile) {
@@ -78,6 +86,7 @@ tiledb_profile_dir <- function(profile) {
7886

7987
#' Set a parameter on the 'tiledb_profile' object
8088
#'
89+
#' @param profile A TileDB profile object
8190
#' @param param The key for the new parameter
8291
#' @param value The value for the new parameter
8392
#' @export
@@ -91,6 +100,7 @@ tiledb_profile_set_param <- function(profile, param, value) {
91100

92101
#' Get the value of a parameter set on the 'tiledb_profile' object
93102
#'
103+
#' @param profile A TileDB profile object
94104
#' @param param The key for the parameter to fetch
95105
#' @return The value of the requested parameter or NULL if no such parameter exists
96106
#' @export

man/raw_dump-tiledb_profile-method.Rd

Lines changed: 14 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/tiledb_profile_dir.Rd

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/tiledb_profile_get_param.Rd

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/tiledb_profile_name.Rd

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/tiledb_profile_set_param.Rd

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)