gladkia/vitorcid

A wrapper of vitae to create a CV with the data fetched from ORCID database

vitorcid's Issues

Add support for automated CV creation in Docker container

AC:

• define all R/deb requirements
• prepare Dockerfile
• use custom Docker image in CI
• output valid CV.pdf via vitorcid::get_cv()

Add unit tests

Start with the mockup data (fetched from https://orcid.org/; optionally modified). Use the mockery package.

Add logic for json_path

Add support for custom CV data (not available via https://orcid.org/) via the JSON file.
Update the vignette with a scenario which enables adding the following entries via the JSON file:

• why for education and employment
• address
• current position

Make package CRAN-compatible

• Run R CMD CHECK with --as-cran flag. Fix reported issues.

Improve logic for `get_vitae_r_package_entry`

Recently the CRAN API for search was not working: r-hub/pkgsearch#111.
It can happen that CRAN or BioC API do not work. Let's improve the logic.
AC:

• use tryCatch when checking the R packages with pkgsearch link or biocondcutor link
• if given service fails:

• return empty data.table
• raise warning

• add r_packages ad default entry in the entries for get_cv and get_cv_header
• enable the tests for checking CRAN packages: https://github.com/gladkia/vitorcid/blob/main/tests/testthat/test-vitae.R

Add vignette with basic scenario of use

Some topics to be covered

1. Authorization

• authorization as described in https://github.com/ropensci-archive/rorcid/blob/master/vignettes/authentication.Rmd
• required env variables: ‘ORCID_TOKEN’ and ORCID_ID’

2. creating and filling in data on https://orcid.org/
3. creating CV - basic/fast track
   vitorcid::get_cv(“CV”)
4. previewing output (generated CV)
5. customizing CV via Rmd output
6. customizing CV via additional entries on https://orcid.org

Add CI with pkdown support

1. CI template: https://github.com/gladkia/igvShiny/blob/master/.github/workflows/check-bioc.yml
2. add pkgdown sections with roxygen2 keywords

Add Rmd template validation

Inspiration: https://rstudio.github.io/pointblank/articles/VALID-VI.html

Add support for all templates from vitae

Currently, the template is hardcoded: https://github.com/gladkia/vitorcid/blob/main/R/rorcid.R#L161
There are six templates provided by vitae: https://github.com/mitchelloharawild/vitae/blob/master/tests/testthat/test-template.R

AC:

• support all six templates via the dedicated parameter
• support additional template parameters (if given template has them):

> formals(vitae::awesomecv)
$...


$latex_engine
[1] "xelatex"

$page_total
[1] FALSE

$show_footer
[1] TRUE

> formals(vitae::twentyseconds)
$...


> formals(vitae::moderncv)
$...


$theme
c("casual", "classic", "oldstyle", "banking", "fancy")

$latex_engine
[1] "pdflatex"