Skip to content
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.

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

Feat/tidy fill #74

Draft
wants to merge 32 commits into
base: master
Choose a base branch
from
Draft

Feat/tidy fill #74

wants to merge 32 commits into from

Conversation

timcadman
Copy link
Collaborator

@timcadman timcadman commented Oct 3, 2024

Checklist for developing new functions

  • Write clientside function
  • Write serverside function
  • Evaluate whether additional disclosure checks are required, and if so write them
  • Update .circleci/config.yml so that CI installs 'molgenis/tidyverse' from corresponding branch
  • Add serverside function to inst/DATASHIELD file
  • On clientside package run devtools::check(). Review and fix any broken tests.
  • On serverside package run devtools::check(). Review and fix any broken tests.
  • Add new clientside tests to 'tests/testthat'
  • Add new serverside tests to 'tests/testthat'
  • Update clientside README.md to list function as included
  • Update clientside vignette with example(s) of new function use
  • Check clientside function documentation is correct and complete
  • Check serverside function documentation is correct and complete
  • On clientside package run devtools::check() and devtools::build_site()
  • On serverside package run devtools::check() and devtools::build_site()

How to test

  • Pull feat/bind-cols branch from molgenis/dsTidyverseClient
  • Pull feat/bind-cols branch from molgenis/dsTidyverse
  • Run: devtools::load_all(path-to-clientside-package)
  • Start Armadillo on localhost
  • Start xenon profile
  • Install package on server:
devtools::build(path-to-serverside-package)
local_url <- "http://localhost:8080"
armadillo.login(local_url)
armadillo.install_packages(path-to-built-serverside-package, profile = "xenon")
  • Upload test data:
data("mtcars")
armadillo.create_project("tidyverse")
armadillo.upload_table("tidyverse", "data", mtcars)
  • Log in and assign data:
token <- armadillo.get_token(local_url)
builder <- newDSLoginBuilder()

builder$append(
  url = local_url,
  server = "cohort_1",
  token = token,
  driver = "ArmadilloDriver",
  profile = "xenon")

builder$append(
  url = local_url,
  server = "cohort_2",
  token = token,
  driver = "ArmadilloDriver",
  profile = "xenon")

builder$append(
  url = local_url,
  server = "cohort_3",
  token = token,
  driver = "ArmadilloDriver",
  profile = "xenon")

logindata <- builder$build()
conns <- datashield.login(logins = logindata, assign = FALSE)

datashield.assign(
  symbol = "mtcars",
  value = "tidyverse/data/mtcars",
  conns = conns)
  • Run the test lines for tests/testthat/[new-function].R Ignore the setting up a DSLite environment.

In addition:

  • run `devtools::check()
  • read vignette

Copy link

codecov bot commented Oct 3, 2024

Codecov Report

Attention: Patch coverage is 94.21965% with 10 lines in your changes missing coverage. Please review.

Project coverage is 96.4%. Comparing base (4a42f72) to head (efe7e53).
Report is 2 commits behind head on master.

Files with missing lines Patch % Lines
R/ds.standardiseDf.R 94.2% 10 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff            @@
##           master     #74     +/-   ##
========================================
- Coverage   100.0%   96.4%   -3.6%     
========================================
  Files          15      16      +1     
  Lines         112     285    +173     
========================================
+ Hits          112     275    +163     
- Misses          0      10     +10     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant