search

phuse-org / valtools

Validation framework for R packages used in clinical research and drug development.
https://phuse-org.github.io/valtools/
Other
51 stars 10 forks source link

Difference between Requirement Name and Requirement ID #219

Open lbau7 opened 2 years ago

lbau7 commented 2 years ago

When I use vt_scrape_requirement_editors() %>% vt_kable_requirement_editors() the @title of the requirements markdown file appears under the column "Requirement ID". However, with vt_scrape_risk_assessment() %>% vt_kable_risk_assessment() the @title appears under "Requirement Name". Is this intentional`? I do not understand the difference between Requirement Name and Requirement ID.

thebioengineer commented 2 years ago

hey @lbau7 - they are the same thing, and its an unintentional difference between the two kable-functions. we should ideally have the same thing, and both are Requirement Name.

Noting for future resolution: vt_kable_requirement_editors:
https://github.com/phuse-org/valtools/blob/c11ad030b7265a0a312070b7b6838f45e072563f/R/scrape_authorship.R#L140

vt_kable_risk_assessment: https://github.com/phuse-org/valtools/blob/c11ad030b7265a0a312070b7b6838f45e072563f/R/risk_table.R#L54