Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Target descriptions #1236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 22 commits into from
Feb 19, 2024
Merged

Target descriptions #1236

merged 22 commits into from
Feb 19, 2024

Conversation

wlandau
Copy link
Member

@wlandau wlandau commented Feb 19, 2024

Prework

Related GitHub issues and pull requests

Summary

tar_target() gains a new description argument for free-form text to describe what the target is about.

# _targets.R
library(targets)
list(
  tar_target(
    name = data,
    command = airquality,
    description = "airquality dataset from base R"
  ),
  tar_target(
    name = model1,
    command = broom::tidy(lm(Ozone ~ Temp, data = data)),
    description = "model of ozone against temperature (degrees F)"
  ),
  tar_target(
    name = model2,
    command = broom::tidy(lm(Ozone ~ Wind, data = data)),
    description = "model of ozone against wind speed (mph)"
  )
)

The descriptions show up in tar_manifest(), tar_network(), tar_glimpse(), tar_visnetwork(), and tar_mermaid().

library(targets)
tar_mermaid()
graph LR
  style Legend fill:#FFFFFF00,stroke:#000000;
  style Graph fill:#FFFFFF00,stroke:#000000;
  subgraph Legend
    direction LR
    x0a52b03877696646([""Outdated""]):::outdated --- xbf4603d6c2c2ad6b([""Stem""]):::none
  end
  subgraph Graph
    direction LR
    xb7119b48552d1da3(["data<br>airquality dataset from base R"]):::outdated --> xd2415809dfccb1c9(["model1<br>model of ozone against temperature (degrees F)"]):::outdated
    xb7119b48552d1da3(["data<br>airquality dataset from base R"]):::outdated --> x5e90f77e4394a7c0(["model2<br>model of ozone against wind speed (mph)"]):::outdated
  end
  classDef outdated stroke:#000000,color:#000000,fill:#78B7C5;
  classDef none stroke:#000000,color:#000000,fill:#94a4ac;
  linkStyle 0 stroke-width:0px;
Loading

tar_described_as() is a wrapper around tidyselect::any_of() to allow grouping of different targets based on the description rather than the name.

tar_manifest(names = tar_described_as(starts_with("model"))) # Does not show the dataset.
#> # A tibble: 2 × 3
#>   name   command                                    description                               
#>   <chr>  <chr>                                      <chr>                                     
#> 1 model1 broom::tidy(lm(Ozone ~ Temp, data = data)) model of ozone against temperature (degre…
#> 2 model2 broom::tidy(lm(Ozone ~ Wind, data = data)) model of ozone against wind speed (mph) 
tar_make(names = tar_described_as(contains("dataset"))) # Does not run the models.
#> ▶ dispatched target data
#> ● completed target data [0.001 seconds]
#> ▶ ended pipeline [0.055 seconds]

FYI @tjmahr, @noamross, @mattmoo

wlandau added 22 commits February 19, 2024 09:14
@wlandau
Option for the default description
4112781
@wlandau
Document plan for description and tar_described()
46bd395
@wlandau
Put the description in settings
bc5a236
@wlandau
Add tar_described_as()
bbb6620
@wlandau
tar_described_as()
89c5280
@wlandau
typo
9c8f438
@wlandau
Align documentation of 'names'
a738cb9
@wlandau
tar_manifest() descriptions
1ad79eb
@wlandau
Description in glimpse class
c3adb0b
@wlandau
reorder fields
1dd94f1
@wlandau
descriptions in the inspection class
da32d24
@wlandau
tar_network() descriptions
5593441
@wlandau
Truncate characters of description
bf4f4af
@wlandau
rename arg
28b4563
@wlandau
use label_width in visual class
4888a6b
@wlandau
tar_config_set() label and label_width defaults
ad2ae47
@wlandau
allow description label
08777ae
@wlandau
descriptions in tar_visnetwork
4c513bf
@wlandau
label widths in tar_visnetwork() and tar_mermaid(), descriptions in t…
55ce991 
…ar_mermaid()
@wlandau
Target descriptions
c394d7f
@wlandau
Fix #1235
e75aba0
@wlandau
Version and news
44acd3e
@wlandau wlandau merged commit 78a653f into main Feb 19, 2024
@wlandau wlandau deleted the 1230 branch February 19, 2024 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@wlandau