Skip to main content

kp_user_pw

KenPom Login and Password credentials

Description#

Save your KenPom login e-mail and password as the system environment variables KP_USER and KP_PW

Requires a subscription to KenPom.com

Usage#

login(user_email = Sys.getenv("KP_USER"), user_pw = Sys.getenv("KP_PW"))kp_user_email()kp_password()has_kp_user_and_pw()

Arguments#

ArgumentDescription
user_emailUser subscription e-mail
user_pwUser subscription password

Details#

list("Using your KenPom subscription with the package:") list()

Run usethis::edit_r_environ() and THEN paste the following in the new script that pops up (without quotations)

KP_USER = YOUR-EMAIL@DOMAIN.COMKP_PW = XXX-YOUR-PASSWORD-XXX

You can save the login information for consistent usage by adding

KP_USER = YOUR-EMAIL@DOMAIN.COM`KP_PW = XXX-YOUR-PASSWORD-XXX

to your .REnviron file (easily accessed via usethis::edit_r_environ()). For less consistent usage: At the beginning of every session or within an R environment, save your login e-mail and password as the environment variables KP_USER and KP_PW (with quotations) using a command like the following.

Sys.setenv(KP_USER = YOUR-EMAIL@DOMAIN.COM)Sys.setenv(KP_PW = XXX-YOUR-PASSWORD-XXX)