Save datasets in a yaml file

Save datasets in a yaml file

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 IssuesTB object.

...

Unused parameter.

dataset_dir

A character string specifying the path which contains the datasets (only taken into account if source is set to "local"). Defaults to the package option IssueTrackeR.dataset.dir.

dataset_name

A character string specifying the name of the datasets which will be written (only taken into account if source is set to "local"). Defaults to "open_issues.yaml".

verbose

A logical value indicating whether to print additional information. Default is TRUE.

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).

Value

invisibly (with invisible()) TRUE if the export was successful and an error otherwise.

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.

Examples

path <- system.file("data_issues", package = "IssueTrackeR")
issues <- get_issues(
    source = "local",
    dataset_dir = path,
    dataset_name = "list_issues.yaml"
)
#> The issues will be read from /home/runner/work/_temp/Library/IssueTrackeR/data_issues/list_issues.yaml.
milestones <- get_milestones(
    source = "local",
    dataset_dir = path,
    dataset_name = "list_milestones.yaml"
)
#> The milestones will be read from /home/runner/work/_temp/Library/IssueTrackeR/data_issues/list_milestones.yaml.
labels <- get_labels(
    source = "local",
    dataset_dir = path,
    dataset_name = "list_labels.yaml"
)
#> The labels will be read from /home/runner/work/_temp/Library/IssueTrackeR/data_issues/list_labels.yaml.

write_issues_to_dataset(issues)
#> The datasets will be exported to /tmp/RtmpELgOGr/data/list_issues.yaml.
write_labels_to_dataset(labels)
#> The datasets will be exported to /tmp/RtmpELgOGr/data/list_labels.yaml.
#> The file already exists and will be overwritten.
write_milestones_to_dataset(milestones)
#> The datasets will be exported to /tmp/RtmpELgOGr/data/list_milestones.yaml.
#> The file already exists and will be overwritten.