Cu câțiva ani în urmă, comunitatea R a început să folosească Orcid („Open Researcher and Clotizor ID”) pentru a identifica în mod persistent și unic autori individuali ai pachetelor din descriere. Ideea este următoarea: Introduceți Orcidul autorilor ca un comentariu special numit în person() obiect. De exemplu, pot fi reprezentat de:
person("Maëlle", "Salmon", , "(email protected)", role = c("cre", "aut"),
comment = c(ORCID = "0000-0002-2815-0399"))
Deși oricine ar putea folosi orcidul, rău sau din neatențiecu siguranță beneficiați de utilizarea Orcidului dvs. în munca dvs. În cazul pachetelor R, paginile CRAN și site -urile PKGDown prezintă o pictogramă destul de conectată la profilul dvs. Orcid, care la rândul său se poate conecta la prezența dvs. preferată online. Recunoaştere! Branding personal!
Anul acesta, exact aceeași idee a fost aplicată organizații Utilizarea ID -urilor ROR („Registrul organizațiilor de cercetare”). Orice organizație, fie că este o organizație de cercetare, o inițiativă sau o companie, poate solicita să fie listată în registru. Cu câteva luni în urmă, a devenit posibil să se enumere ROR IDS în descriere, pe care în prezent câteva zeci de pachete Cran -ul – deși acest lucru este încă departe de miile de pachete Cran care adoptă orciduri. Mulțumim lui R Core pentru adăugarea funcției și lui Ahim Zeileis pentru răspândirea știrilor.
Un întreținător de pachete ar putea avea nevoie să enumere organizațiile din DESCRIPTION: De exemplu, o companie care deține drepturile de autor către pachet (rolul „CPH”), o entitate care a finanțat lucrări pe software (rolul „FND”). Adăugarea ID -ului ROR al organizației la person() Obiectul îl identifică și mai clar. Ca ilustrare, Ropensci poate fi reprezentat de:
person("rOpenSci", role = "fnd",
comment = c("https://ropensci.org/", ROR = "019jywm96"))
Pictograma ROR, deși mai puțin izbitoare decât pictograma orcid verde strălucitor, apare pe pagina CRAN a pachetului și se leagă de pagina ROR a organizației, care la rândul său se poate conecta la site -ul organizației:
În 2018 am raportat despre instrumentele pentru utilizarea Orcid. Anul acesta, am dori să explicăm instrumentul pentru a include ROR IDS.
ROR Support în ecosistemul {DevTools}
Odată ce ROR ID -urile au fost susținute de baza R, un următor etapă tehnică a fost ca aceștia să fie susținuți de „ecosistemul DevTools” de către Posit. Chiar dacă DevTools nu este strict necesar pentru dezvoltarea pachetelor, mulți dezvoltatori de pachete, inclusiv unii din comunitatea Ropensci, folosesc DevTools.
Codul care acceptă ROR în desc, Roxygen2 și PKGDown urmează codul care acceptă Orcid în aceste pachete. Este foarte norocos faptul că s -a adăugat suport orcid înainte de ROR, deoarece „Orcid” este un șir mai bun pentru a căuta decât „ROR” care apare, să zicem, „eroare”. 😸
ROR IDS Support în {desc}
Pachetul desc, întreținut de Gábor Csárdi, vă ajută să manipulați DESCRIPTION fișiere programatic. În versiunea sa de dezvoltare curentă, toate funcțiile care gestionează autorii (adăugarea, căutarea sau completarea intrărilor) prezintă acum un ror argument. Mai mult, o nouă funcție, desc_add_ror()a fost creat.
De exemplu, puteți adăuga un ID ROR la o intrare de autor:
desc::desc_add_ror("019jywm96", given = "rOpenSci")
Puteți adăuga o intrare de autor, inclusiv ID -ul ROR:
desc::desc_add_author(given = "rOpenSci", ror = "019jywm96", role = "fnd")
Aceste funcții pot fi la îndemână pentru a actualiza o mulțime de pachete simultan. Chiar dacă pachetele sunt actualizate unul câte unul, este mai scurt să partajați și să aplicați instrucțiunile ca fragment de cod.
ROR suport în {roxygen2}
Pachetul Roxygen2, întreținut de Hadley Wickham, generează pachetul dvs. NAMESPACE și pagini manuale folosind comentarii special formatate. Printre acele pagini manuale, pachetul dvs. ar putea (și ar trebui, potrivit Ghidului nostru Dev) să conțină unul la nivel de pachet. Puteți crea o astfel de pagină folosind usethis::use_package_doc(). Următorul conținut va fi adăugat la R/package-name-package.Rde exemplu R/usethis-package.R.
#' @keywords internal "_PACKAGE" ## usethis namespace: start ## usethis namespace: end NULL
Funcţionare devtools::document() va crea un fișier RD pentru ?package-nameal cărui conținut provine DESCRIPTIONinclusiv Orcids și ROR IDS.
În acest caz, poate doriți să instalați versiunea de dezvoltare a Roxygen2 pentru a vedea ID -ul ROR reformatat în mod corespunzător la o adresă URL. Exemplu de pachet Tinkr: sursa docului la nivel de pachet, pagina manuală la nivel de pachet, pagina manuală pe pkgdown.
ROR suport în {pkgdown}
Pachetul PKGDown, întreținut de Hadley Wickham, creează un site de documentație pentru pachetul dvs. pe baza metadatelor și documentației sale. De la versiunea sa 2.1.2, ROR IDS IN DESCRIPTION sunt transformate în pictograme, similare cu ID -urile Orcid.
Bara laterală a site -ului web Tinkr include o pictogramă ROR în apropiere de numele Ropensci.
Asistență pentru pictogramele ROR?
În prezent, pictogramele ROR precum cele de pe paginile CRAN, site -urile web PKGDown și subsolul site -ului nostru provin din fișiere. Cu toate acestea, am deschis o solicitare de pictogramă pentru ROR în depozitul Font Awesome, pe care îl puteți îmbunătăți folosind Thumbs Up. Această strategie a funcționat pentru Orcid. Există deja o pictogramă ROR în Biblioteca Academiconilor mai specializați.
Concluzie: mergeți mai departe, înregistrați -vă și folosiți ROR IDS!
În această notă tehnologică, am explicat care sunt ROR IDS: ID -uri persistente pentru organizații. Sunt pentru organizații ceea ce sunt orcidele pentru indivizi. Am arătat că ROR ID -urile sunt acceptate în ecosistemele de bază R și DevTools.
ROR IDS vă poate ajuta să identificați mai clar o entitate pe care o enumerați în pachetul dvs. DESCRIPTION Pentru că, să zicem, a finanțat lucrarea sau deține drepturile de autor. Vă încurajăm să vă înregistrați organizația la Registrul Organizației de Cercetare și să utilizați ID -ul rezultat în pachetul dvs. DESCRIPTION. O astfel de sarcină ar putea fi abordată în timpul unei curățări de primăvară a pachetului.
