rcompendium (version 1.3)

set_credentials: Store credentials to the .Rprofile

Description

This function is used to store user credentials in the .Rprofile file. Accepted credentials are listed below. This function is useful if user creates a lot of packages and/or research compendiums.

If the .Rprofile file does not exist this function will create it. Users need to paste the content of the clipboard to this file.

Usage

set_credentials(
  given = NULL,
  family = NULL,
  email = NULL,
  orcid = NULL,
  protocol = NULL
)

Value

No return value.

Arguments

given

A character of length 1. The given name of the project maintainer.

family

A character of length 1. The family name of the project maintainer.

email

A character of length 1. The email address of the project maintainer.

orcid

A character of length 1. The ORCID of the project maintainer.

protocol

A character of length 1. The GIT protocol used to communicate with the GitHub remote. One of 'https' or 'ssh'. If you don't know, keep the default value (i.e. NULL) and the protocol will be 'https'.

See Also

Other setup functions: new_compendium(), new_package(), refresh()

Examples

if (FALSE) {
library(rcompendium)


## Define **ONCE FOR ALL** your credentials ----

set_credentials("John", "Doe", "[e-mail]", 
                orcid = "9999-9999-9999-9999", protocol = "https")
}