Amiral 1.3.0: Documentare Go !! | R-BLOGGERS

Actualizare titlu: documentație care vă oferă

Actualizarea noastră de încoronare Acest ciclu de lansare este …

Actualizări de documentare!

Hmmm, nu sună suficient de fantezist? Ce zici de …

Actualizări de documentare !!

Încă nu este atât de interesant? Ei bine, permiteți -ne să vă răzgândiți cu un exemplu. Iată care este secțiunea Exemple din pagina de referință amiral :: derive_extreme_records () arăta ca în {amiral} 1.2:

Și iată cum arată {amiral} 1.3:

Asta e corect! Unele dintre exemplele noastre de referință au fost acum îmbunătățite astfel încât:

• Fiecare exemplu are un titlu, care este prezentat și în tabelul conținutului și o descriere care explică ce se întâmplă.
• Exemplele se construiesc adesea în complexitate, pornind de la o simplă aplicare a funcției într-o carcasă de jucărie și construind până la mai multe cazuri de utilizare structurate.
• Exemplele pentru această funcție acoperă acum toate argumentele funcției.

Ca de obicei, puteți accesa aceste exemple de referință de pe site -ul nostru de documentare sau, în mod alternativ, direct din panoul de ajutor al lui Rstudio, tastând ?function_name în consolă.

Pentru această primă iterație, am vizat unele dintre cele mai complexe, flexibile și importante funcții din interior {amiral} . Funcțiile care au primit acest exemplu de tratament îmbunătățit sunt:

Asta nu înseamnă că celelalte funcții nu mai au exemple; Mai degrabă, păstrează materialul anterior.

Acum, scopul nostru ca echipă de dezvoltare este să îmbunătățim continuu exemplele de referință ale portofoliului nostru mare de funcții în mod regulat pe ciclurile de eliberare. Dacă doriți să jucați un rol, aceasta este, de asemenea, o oportunitate excelentă de a contribui {amiral} Tuți – Vă rugăm să luați legătura cu echipa noastră de dezvoltare prin Slack sau GitHub Repo și am fi fericiți să vă ajutăm să începeți.

De asemenea, am făcut diverse alte mici îmbunătățiri de documentare, pe care le puteți folosi în ChangeLog.

Funcție nouă

Dar nu ne -am oprit acolo! Iată ce altceva este nou în {amiral} 1.3:

• Ne -am îmbunătățit catalogul de funcții cu un nou plus: amiral :: derive_vars_joined_summary () . Această funcție este similară cu amiral :: derive_vars_joined () dar permite derivarea variabilelor sumare (de exemplu, sumă cumulativă, etc.), mai degrabă decât variabile folosind o formulă. De exemplu, iată un exemplu derivat în adae de CUMDOSAdoza cumulată a primit până la un eveniment advers:

library(tibble)
library(dplyr, warn.conflicts = FALSE)
library(admiral)

adex <- tribble(
  ~USUBJID, ~ADY, ~AVAL,
  "1",         1,    10,
  "1",         8,    20,
  "1",        15,    10,
  "2",         8,     5
)

adae <- tribble(
  ~USUBJID, ~ADY, ~AEDECOD,
  "1",         2, "Fatigue",
  "1",         9, "Influenza",
  "1",        15, "Theft",
  "1",        15, "Fatigue",
  "2",         4, "Parasomnia",
  "3",         2, "Truancy"
)

derive_vars_joined_summary(
  dataset = adae,
  dataset_add = adex,
  by_vars = exprs(USUBJID),
  filter_join = ADY.join <= ADY,
  join_type = "all",
  join_vars = exprs(ADY),
  new_vars = exprs(CUMDOSA = sum(AVAL, na.rm = TRUE))
)

# A tibble: 6 × 4
  USUBJID   ADY AEDECOD    CUMDOSA
              
1 1           2 Fatigue         10
2 1           9 Influenza       30
3 1          15 Theft           40
4 1          15 Fatigue         40
5 2           4 Parasomnia      NA
6 3           2 Truancy         NA

• Oferim acum noi metadate de clasificare a laboratorului special adaptat pentru noi unități (convenționale) pe trei criterii de clasificare: NCI-CTCAEV4 (atoxgr_criteria_ctcv4_uscv), Nci-ctcaev5 (atoxgr_criteria_ctcv5_uscv) și daids (atoxgr_criteria_daids_uscv)
• Valorile implicite pentru argumentele funcționale sunt acum afișate întotdeauna în descrierile argumentelor.

Schimbări de rupere

Excluzând deprecierile, avem doar două mici modificări de rupere:

• Am redenumit SI_UNIT_CHECK la UNIT_CHECK În variabilele de metadate de clasificare laborator: atoxgr_criteria_ctcv4(), atoxgr_criteria_ctcv5()și atoxgr_criteria_daids() Pentru a simplifica specificațiile.
• Valorile variabilei specificate pentru tmp_obs_nr_var în amiral :: derive_vars_joined () , amiral :: derive_var_joined_exist_flag () şi Amiral :: Filter_Joined () sunt acum populate diferit dacă există mai multe înregistrări în dataset sau dataset_add pentru aceleași valori ale by_vars și comandă. Înainte ca fiecare dintre aceste înregistrări să i se atribuie o valoare diferită, adică variabila (împreună cu by_vars) a fost un identificator unic. Acum valoarea este aceeași pentru toate aceste înregistrări.

De asemenea, am început să-lletează utilizatorii cu o modificare viitoare a comportamentului implicit al comportamentului implicit al amiral :: derive_vars_dtm () În următoarea noastră versiune (1.4.0), unde vom schimba valoarea implicită a ignore_seconds_flag din FALSE la TRUE. Înaintea acestei schimbări, amiral :: derive_vars_dtm () Acum emite un mesaj util care informează utilizatorii despre următoarea schimbare, pentru a permite atenuarea înainte de timp.

Actualizări ale funcțiilor existente și ale corecțiilor de erori

De asemenea, am fost ocupați să actualizăm unele dintre funcțiile noastre existente ca răspuns la remedierea erorilor și la cererile de îmbunătățiri. O actualizare particulară a notei a fost la amiral :: derive_locf_records, care vine acum cu două noi argumente id_vars_ref şi imputation. id_vars_ref Argumentul permite utilizatorilor să selecteze variabilele pe care să le grupeze în setul de date de referință atunci când determină ce observații să adauge la setul de date de intrare. imputation Argumentul permite utilizatorilor să decidă dacă se actualizează analysis_var Când valoarea ei este NA („Actualizare” și „Update_add”) sau pentru a adăuga o nouă observație în schimb („Adăugare”).

Puteți găsi lista completă de actualizări în ChangeLog.

Concluzie

Am fost cu adevărat încântați de cantitatea de feedback și implicare a utilizatorilor cu pachetul în ultimele șase luni, ceea ce este un motiv important pentru cantitatea de conținut din această nouă versiune. Ca atare, suntem foarte încântați să facem în sfârșit {amiral} 1.3 Disponibil pentru comunitatea farmaceutică și așteaptă cu nerăbdare să continue co-crearea {amiral} împreună!