Introduction to vitorcid

Quick summary

The vitorcid package allows you to generate a CV based on your ORCID profile.

Installation

You can install the package using remotes in the following way:

remotes::install_github("https://github.com/gladkia/vitorcid.git", ref = "main")

Authentication

Take care of the authentication requirements with three steps:

Authenticate with orcid.org as described here.
Create an environment variable ‘ORCID TOKEN’. Use the value obtained from the previous step.

Sys.setenv(ORCID_TOKEN = "__your_token__")

Create an environment variable with your ‘ORCID ID’.

Sys.setenv(ORCID_ID = "__your_orcid_id__")

If you have a problem with authentication, you can also try this path:

restart session in R Studio
create an environment variables with your ‘ORCID_ID’ and ‘ORCID_TOKEN’ as above
sign your ORCID_ID to ‘orcid’
complete authentication your profile using ‘rorcid::orcid_auth()’

*if you change your token use ‘rorcid::orcid_auth(reauth = TRUE)’
load package using ‘library(“vitorcid”)’

CV generation - fast path

Create an account on https://orcid.org/.

This is an example of a completed profile: link.

Employment and Education sections are required.

Websites and Social Links are encouraged but not mandatory.

Generate your CV:

vitorcid::get_cv("CV")

Review CV.pdf (generated CV). If some corrections are needed you can do them in two ways:

update the data at orcid.org and rerun get_cv
edit the template (CV.Rmd) and knit it (e.g. from within the Rstudio)

You can customize the appearance of your CV and choose one of the available templates. Currently only vitae templates are supported. Templates gallery: link

vitorcid::get_cv(template = "vitae::twentyseconds")

Use cases

Customizing CV data with JSON file

Sometimes one might want to customize the CV data. There are three general cases: * adding the data unavailable from orcid.org * overwriting the data fetched from orcid.org * adding the data not provided at orcid.org

Header data

Currently, there are two header entries that can be provided only via JSON file: ‘position’ and ‘address’. Here is the example JSON file with both entries defined:

j_path <- system.file(package = "vitorcid", "json_examples/orcid_0000-0002-7059-6378_header_data.json")
jsonlite::toJSON(jsonlite::fromJSON(j_path), pretty = TRUE)
#> {
#>   "header_data": {
#>     "position": ["Bioinformatician and R programmer"],
#>     "address": ["Skierniewice, Poland"]
#>   }
#> }

Sometimes, user might want to update the email or profile picture:

j_path <- system.file(package = "vitorcid", "json_examples/orcid_0000-0002-7059-6378_email.json")
jsonlite::toJSON(jsonlite::fromJSON(j_path), pretty = TRUE)
#> {
#>   "header_data": {
#>     "email": ["new_email@email.com"]
#>   }
#> }

j_path <- system.file(package = "vitorcid", "json_examples/orcid_0000-0002-7059-6378_profilepic.json")
jsonlite::toJSON(jsonlite::fromJSON(j_path), pretty = TRUE)
#> {
#>   "header_data": {
#>     "profilepic": ["https://upload.wikimedia.org/wikipedia/commons/thumb/9/9f/Curriculum-vitae-warning-icon.svg/240px-Curriculum-vitae-warning-icon.svg.png"]
#>   }
#> }

One can use the JSON data while getting the latest CV in the following way:

vitorcid::get_cv(json_path = j_path)

Non-header data

One is not able to provide details about specific employment or education entries at the orcid.org. Here is the example of defining such details for the user with ORCID ID: “0000-0002-7059-6378”. In his case there are four employment and two education entries (see details here.

# defining details with idx (counting from the top to the bottom)
j_path <- system.file(package = "vitorcid", "json_examples/orcid_0000-0002-7059-6378_why_idx.json")
jsonlite::toJSON(jsonlite::fromJSON(j_path), pretty = TRUE)
#> {
#>   "employment": [
#>     {
#>       "idx": 1,
#>       "why": "developing biomedical R packages, especially those related to Next-Generation Sequencing data__developing R/Shiny application for visualization of NGS data__developing R/Shiny application for visualization of dose-response data (technical leader)"
#>     },
#>     {
#>       "idx": 2,
#>       "why": "conducting classes (bioinformatics basics) for Biotechnology students (Faculty of Chemistry)"
#>     },
#>     {
#>       "idx": 3,
#>       "why": "conducting in silico research__presenting the findings during conferences__developing bioinformatics pipelines__conducting classes (bioinformatics basics)__mentoring undergraduate students"
#>     },
#>     {
#>       "idx": 4,
#>       "why": "manual testing of webservices"
#>     }
#>   ],
#>   "education": [
#>     {
#>       "idx": 1,
#>       "why": "PhD thesis title: Evolution of dominance and antibacterial drug targets"
#>     },
#>     {
#>       "idx": 2,
#>       "why": "Master thesis title: Inferring potential bubonic plague drug targets from the analysis of predicted protein interactions network of Yersinia pestis KIM"
#>     }
#>   ]
#> }

# defining details with put-code(s) from orcid.org
# each put-code refers to the given record from education/employment
j_path <- system.file(package = "vitorcid", "json_examples/orcid_0000-0002-7059-6378_why_put-code.json")
jsonlite::toJSON(jsonlite::fromJSON(j_path), pretty = TRUE)
#> {
#>   "employment": [
#>     {
#>       "put-code": 21893486,
#>       "why": "developing biomedical R packages, especially those related to Next-Generation Sequencing data__developing R/Shiny application for visualization of NGS data__developing R/Shiny application for visualization of dose-response data (technical leader)"
#>     },
#>     {
#>       "put-code": 21893493,
#>       "why": "conducting classes (bioinformatics basics) for Biotechnology students (Faculty of Chemistry)"
#>     },
#>     {
#>       "put-code": 21893501,
#>       "why": "conducting in silico research__presenting the findings during conferences__developing bioinformatics pipelines__conducting classes (bioinformatics basics)__mentoring undergraduate students"
#>     },
#>     {
#>       "put-code": 21893522,
#>       "why": "manual testing of webservices"
#>     }
#>   ],
#>   "education": [
#>     {
#>       "put-code": 21893544,
#>       "why": "PhD thesis title: Evolution of dominance and antibacterial drug targets"
#>     },
#>     {
#>       "put-code": 21893532,
#>       "why": "Master thesis title: Inferring potential bubonic plague drug targets from the analysis of predicted protein interactions network of Yersinia pestis KIM"
#>     }
#>   ]
#> }