check. package.

DESCRIPTION

@@ -1,10 +1,11 @@
 Package: FixedEffectjlr
 Type: Package
-Title: Fixed Effect Models in R
+Title: A package for fast Fixed Effect Models in R
 Version: 0.1.0
 Date: 2018-03-22
 Authors@R: person("Erik", "Loualiche", email = "[email protected]", role = c("aut", "cre"))
-Description: Implements a R wrapper for FixedEffectModels julia package
+Description: Implements a R wrapper for FixedEffectModels julia package. 
+  This lies heavily on both the JuliaCall package and the tools developed by Matthieu Gomez.
 License: MIT + file LICENSE
 BugReports: https://github.com/eloualiche/FixedEffectjlr/issues
 Encoding: UTF-8

NAMESPACE

@@ -8,6 +8,8 @@ export(FixedEffect_nse)
 export(FixedEffect_setup)
 import(JuliaCall)
 import(data.table)
+importFrom(stats,as.formula)
+importFrom(stats,terms)
 importFrom(stringr,str_length)
 importFrom(stringr,str_replace_all)
 importFrom(stringr,str_split)

R/FixedEffectIV.R

@@ -8,14 +8,15 @@
 #' @param fe        expression of fixed effects id1 + id2:id3
 #' @param vcov      error types, expression either robust or cluster(id1)
 #' @param weights   expression of weights
-#' @param vcov      Specification for the error
 #' @param save_res  Do we save the residuals
+#' @param print     Do we print the results (default is yes)
 #'
 #' @return The return value will be a list which contains two elements at this point
 #'   results: includes most of the observation from the julia call
 #'   summary: includes information that is of importance to write a table
 #'
-#' @examples See vignettes and readme
+#' @examples
+#'   # See vignettes and readme
 #'
 #' @export
 #####################################################################################################################
@@ -116,8 +117,10 @@ FixedEffectIV_nse <- function(
 
   # Run the regression
   julia_command(julia_regcall)
-  julia_command("reg_res")
 
+  if (print == T){
+    julia_command("reg_res")
+  }
 
 
 }

R/FixedEffectInteract.R

@@ -10,15 +10,19 @@
 #' @param fe        expression of fixed effects id1 + id2:id3
 #' @param weights   expression of weights
 #' @param vcov      Specification for the error
+#' @param save_res  Save the results of the model
 #'
 #' @return The return value will be a list which contains two elements at this point
 #'   results: includes most of the observation from the julia call
 #'   summary: includes information that is of importance to write a table
 #'
-#' @examples See vignettes and readme
-#'   Short example
-#'   > df = Ecdat::Cigar
-#'   > FixedEffectInteract(df, "sales", "price", "state+year", 2, "state", vcov = "robust")
+#' @examples
+#' # See vignettes and readme
+#' # Short example
+#' \dontrun{
+#'   df = Ecdat::Cigar
+#'   FixedEffectInteract(df, "sales", "price", "state+year", 2, "state", vcov = "robust")
+#' }
 #'
 #' @export
 #####################################################################################################################

R/FixedEffectModels.R

@@ -9,12 +9,14 @@
 #' @param weights   Regression weights
 #' @param vcov      Specification for the error
 #' @param save_res  Do we save the residuals
+#' @param print     Do we save the results
 #'
 #' @return The return value will be a list which contains two elements at this point
 #'   results: includes most of the observation from the julia call
 #'   summary: includes information that is of importance to write a table
 #'
-#' @examples See vignettes and readme
+#' @examples
+#' # See vignettes and readme
 #'
 #' @export
 #####################################################################################################################
@@ -204,20 +206,24 @@ FixedEffect <- function(dt,
 
 #' Use FixedEffectModels.jl to run large fixed effect models in julia on multiple models
 #'
-#' \code{FixedEffect_models} returns the results of a linear fixed effect regression
+#' \code{FixedEffect_nse} returns the results of a linear fixed effect regression
 #'
 #' @param dt        dataset of interest
 #' @param formula   formula of the y ~ x1 + x2 type
 #' @param fe        expression of fixed effects id1 + id2:id3
 #' @param weights   expression of weights
 #' @param vcov      error types, expression either robust or cluster(id1)
+#' @param ...       Variables that we pass by to FixedEffect function like print and save_res
 #'
 #' @return The return value will be a list which contains two elements at this point
 #'   results: includes most of the observation from the julia call
 #'   summary: includes information that is of importance to write a table
 #'
-#' @examples See vignettes and readme
+#' @examples
+#' # See vignettes and readme
+#' \dontrun{
 #'   FixedEffect_nse(y ~ x1 + x2, id1 + id2, cluster(id1), save = T)
+#' }
 #'
 #' @export
 #####################################################################################################################
@@ -268,21 +274,21 @@ FixedEffect_nse <- function(dt,
 #' @param fe        String, a vector of Fixed effects
 #' @param weights   Vector of regression weights (not yet coded)
 #' @param vcov      Vector of specification for the error
-#' @param save_res  Do we save the residuals (not yet coded)
 #'
 #' @return The return value will be a list which contains two elements at this point
 #'   results: includes most of the observation from the julia call
 #'   summary: includes information that is of importance to write a table
 #'
-#' @examples See vignettes and readme
-#'
+#' @examples
+#'   # See vignettes and readme
+#' \dontrun{
 #' lhs <- c("log_ewemt", "f1_log_ewemt")
 #' rhs <- c("MP + retail_index + retail_index_MP",
 #'         "MP + discount_rate + discount_rate_MP")
 #' fe  <- c("date_y",
 #'          "date_y:fed_district + quarter:fed_district + industry_code_num:quarter")
 #' vcov <- c("robust", "cluster(date_y)")
-#'
+#' }
 #' @export
 #####################################################################################################################
 FixedEffect_models <- function(

R/FixedEffectjlr.R

@@ -1,7 +1,10 @@
-#' A package for asset pricing analysis
+#' FixedEffectjlr a package for Fixed Effect Models
+#'
+#' FixedEffectjlr uses juliacall and `FixedEffectModels.jl` to perform
+#'   fast high dimensional fixed effect regressions within R
+#'
 #'
 #' @docType package
-#' @name FixedEffectjlr
 #'
 #' @import data.table
 #' @import JuliaCall
@@ -10,5 +13,10 @@
 #' @importFrom stringr str_split
 #' @importFrom stringr str_length
 #'
-NULL
+#' @importFrom stats as.formula
+#' @importFrom stats terms
+#'
+"_PACKAGE"
+
+
 

tests/testthat/test-StandardLM.R

@@ -1,5 +1,6 @@
 context("Standard Linear Model")
 
+library(Ecdat)
 df = Ecdat::Cigar
 
 test_that("run the Linear Model example", {