Merge pull request ixpantia#43 from ronnyhdez/T38

Ref ixpantia#38 examples documentation

R/get_account_information.R

@@ -12,6 +12,13 @@ NULL
 #' @param user_code The user code to identify your account
 #' @param api_token The api token to connect to your account
 #'
+#'@examples
+#'\dontrun{
+#'get_account_information(user_code = "6A6E88",
+#'                        api_token = "FBHV7C")
+#'}
+#'
+#'
 #' @export
 get_account_information <- function(user_code, api_token) {
   if (missing(user_code)) {

R/get_contact_information.R

@@ -11,6 +11,13 @@ NULL
 #' @param contact_id The contact name or other term to make an specific call
 #' to the API.
 #'
+#' @examples
+#'\dontrun{
+#'get_contact_information(user_code = "6A6E88",
+#'                        api_token = "TQ9XM",
+#'                        contact_id = "Fulano")
+#'}
+#'
 #' @export
 get_contact_information <- function(user_code, api_token, contact_id = "") {
   if (missing(user_code)) {

R/get_pipeline_report.R

@@ -13,6 +13,13 @@ NULL
 #' @param api_token The api token to connect to your account
 #' @param pipelineid The id of the pipeline you want to get the report from
 #'
+#' @examples
+#'\dontrun{
+#'get_pipeline_report(user_code = "6A6E88",
+#'                     api_token = "96066",
+#'                     pipelineid = "57102821")
+#'}
+#'
 #' @export
 get_pipeline_report <- function(user_code, api_token, pipelineid) {
   if (missing(user_code)) {

R/search_contacts.R

@@ -11,6 +11,14 @@ NULL
 #' @param search_term The contact name or other term to make an specific call
 #' to the API. If you  want to search for group enter "Group:GROUP_NAME"
 #'
+#'
+#' @examples
+#'\dontrun{
+#'search_contacts(user_code = "6A6E88",
+#'                api_token = "TQ9XM",
+#'                search_term = "brenesii")
+#'}
+#'
 #' @export
 search_contacts <- function(user_code, api_token, search_term = "") {
   if (missing(user_code)) {