Skip to contents

Contact Copernicus Marine login page

Source: R/cms_login.r
cms_login.Rd

[Stable] Contact Copernicus Marine login page and check if login is successful.

Usage

cms_login(
  username = getOption("CopernicusMarine_uid", ""),
  password = getOption("CopernicusMarine_pwd", "")
)

Arguments

username

Your Copernicus marine user name. Can be provided as options(CopernicusMarine_uid = "my_user_name"), or as argument here.

password

Your Copernicus marine password. Can be provided as options(CopernicusMarine_pwd = "my_password"), or as argument here.

Value

Returns a logical value indicating if the login is successful. The response from the login page is returned as an attribute named response.

Details

This function will return a logical value indicating if the login is successful. It can be used to test your account details.

Author

Pepijn de Vries

Examples

if (FALSE) {
## This will return FALSE if you have not set your account details with 'options'.
## If you have specified your account details and there are no other problems,
## it will return TRUE.
copernicus_login()
}