diff --git a/NEWS.md b/NEWS.md index 6aff3f89..aba0ce6b 100644 --- a/NEWS.md +++ b/NEWS.md @@ -3,6 +3,8 @@ ## New Features - Calls for `admiral.test` have been swapped with `pharmaversesdtm` (#321) +- New vignette for package writing extensions is now available (#295, #312) +- New vignette for creating test data is now available (#282) ## Updates of Existing Functions @@ -31,6 +33,7 @@ - Minor updates to pull request review guidance were added (#201, #292) - Documentation of singular versus plural function argument names was added into the programming strategy vignette. Also documentation on the common arguments `missing_value` and `missing_values` was added. (#296) - Documentation highlighting the difference between `set_values_to` and `keep_source_vars` (#318) +- List of common arguments was updated (#306) ## Various diff --git a/vignettes/package_extensions.Rmd b/vignettes/package_extensions.Rmd index 7325569e..99b2752e 100644 --- a/vignettes/package_extensions.Rmd +++ b/vignettes/package_extensions.Rmd @@ -57,7 +57,7 @@ _Note: The ordering numbers below are suggested but don't all need to strictly b 1. Agree on a charter and expectations of each company, e.g. we usually ask for at least 3 developers with at least 25% capacity and a mix of R, GitHub and TA experience. Within the charter make sure the scope and timelines are clear. _It is important here not to try to boil the ocean. Focus first on the very common endpoints required as a foundation and then the package can build up from here via contributions from both the co-development companies and also the wider across-industry admiral community. If useful, the `{admiralonco}` charter could be shared as a guide._ 1. Each company should start to identify the required developer resources. Then each developer is required to complete the `{admiral`} [dummy issue for onboarding](https://github.com/pharmaverse/admiral/issues/1839), as well as reading up on the [admiraldev documentation](https://pharmaverse.github.io/admiraldev/devel/index.html), - especially the developer guides, which all need to be followed for package extensions. -![Dummy issue for new developers](https://github.com/pharmaverse/admiraldev/raw/312_break_the_wall_package_extension%40devel/vignettes/dummy_issue.png){width=100%} +![Dummy issue for new developers](https://github.com/pharmaverse/admiraldev/raw/devel/vignettes/dummy_issue.png){width=100%} 1. Optionally it can be useful to host a kick-off meeting to decide how the team will work, for which we recommend agile/scrum practices. @@ -77,7 +77,7 @@ _Note: The ordering numbers below are suggested but don't all need to strictly b 1. Update the template license file in your repo by adding the co-development company names in place of Roche & GSK - for `{admiral}` package extensions we use Apache 2.0, which is our preferred permissive license. Agree with the co-development companies any required extra wording for the copyright/IP section. 1. Set up a project board, such as [this](https://github.com/orgs/pharmaverse/projects/12), to help manage your backlog. -![admiral core project board](https://github.com/pharmaverse/admiraldev/raw/312_break_the_wall_package_extension%40devel/vignettes/project_board.png){width=100%} +![admiral core project board](https://github.com/pharmaverse/admiraldev/raw/devel/vignettes/project_board.png){width=100%} 1. Assuming you work under agile/scrum, then create a product backlog, prioritize and make a sprint plan.