write_issues_to_dataset {IssueTrackeR} | R Documentation |
Save datasets in a yaml file
Description
Save datasets in a yaml file
Usage
write_issues_to_dataset(issues, ...)
## S3 method for class 'IssuesTB'
write_issues_to_dataset(
issues,
dataset_dir = getOption("IssueTrackeR.dataset.dir"),
dataset_name = "list_issues.yaml",
verbose = TRUE,
...
)
## Default S3 method:
write_issues_to_dataset(issues, ...)
write_labels_to_dataset(
labels,
dataset_dir = getOption("IssueTrackeR.dataset.dir"),
dataset_name = "list_labels.yaml",
verbose = TRUE
)
write_milestones_to_dataset(
milestones,
dataset_dir = getOption("IssueTrackeR.dataset.dir"),
dataset_name = "list_milestones.yaml",
verbose = TRUE
)
Arguments
issues |
a |
... |
Unused parameter. |
dataset_dir |
A character string specifying the path which contains the
datasets (only taken into account if |
dataset_name |
A character string specifying the name of the datasets
which will be written (only taken into account if |
verbose |
A logical value indicating whether to print additional
information. Default is |
labels |
a list representing all labels with simpler structure (with name, description, colour) |
milestones |
a list representing milestones with simpler structure (with title, description and due_on). |
Details
Depending on the object, the defaults value of the argument
dataset_name
is:
-
"list_issues.yaml"
for issues; -
"list_labels.yaml"
for labels; -
"list_milestones.yaml"
for milestones.
Value
invisibly (with invisible()
) TRUE
if the export was
successful and an error otherwise.
Examples
path <- system.file("data_issues", package = "IssueTrackeR")
issues <- get_issues(
source = "local",
dataset_dir = path,
dataset_name = "list_issues.yaml"
)
milestones <- get_milestones(
source = "local",
dataset_dir = path,
dataset_name = "list_milestones.yaml"
)
labels <- get_labels(
source = "local",
dataset_dir = path,
dataset_name = "list_labels.yaml"
)
write_issues_to_dataset(issues)
write_labels_to_dataset(labels)
write_milestones_to_dataset(milestones)