better licensing compliance

DESCRIPTION

@@ -1,8 +1,15 @@
 Package: poismf
 Type: Package
 Title: Factorization of Sparse Counts Matrices Through Poisson Likelihood
-Version: 0.3.1
-Author: David Cortes [aut, cre, cph], Jean-Sebastien Roy [cph], Stephen Nash [cph]
+Version: 0.3.1-1
+Authors@R: c(
+  person(given="David", family="Cortes", role=c("aut", "cre", "cph"),
+         email="[email protected]"),
+  person(given="Jean-Sebastien", family="Roy", role="cph",
+         comment="Copyright holder of included tnc library"),
+  person(given="Stephen", family="Nash", role="cph",
+         comment="Copyright holder of included tnc library")
+  )
 Maintainer: David Cortes <[email protected]>
 URL: https://github.com/david-cortes/poismf
 BugReports: https://github.com/david-cortes/poismf/issues

R/poismf.R

@@ -32,6 +32,9 @@
 #' such failed optimizations.
 #' 
 #' For reproducible results, random number generation seeds can be controlled through `set.seed`.
+#' 
+#' Models or recommendation quality can be evaluated using the
+#' \href{https://cran.r-project.org/package=recometrics}{recometrics} package.
 #' @param X The counts matrix to factorize. Can be: \itemize{
 #' \item A `data.frame` with 3 columns, containing in this order:
 #' row index or user ID, column index or item ID, count value. The first two columns will

inst/COPYRIGHTS

@@ -0,0 +1,37 @@
+For the included TNC library (files "tnc.h" and "tnc.c")
+
+Copyright (c) 2002-2005, Jean-Sebastien Roy ([email protected])
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+This software is a C implementation of TNBC, a truncated newton minimization
+package originally developed by Stephen G. Nash in Fortran.
+The original source code can be found at :
+http://iris.gmu.edu/~snash/nash/software/software.html
+Copyright for the original TNBC fortran routines:
+  TRUNCATED-NEWTON METHOD:  SUBROUTINES
+    WRITTEN BY:  STEPHEN G. NASH
+          SCHOOL OF INFORMATION TECHNOLOGY & ENGINEERING
+          GEORGE MASON UNIVERSITY
+          FAIRFAX, VA 22030
+Conversion into C by Elisabeth Nguyen & Jean-Sebastien Roy
+Modifications by Jean-Sebastien Roy, 2001-2002
+SciPy version derived from TNC 1.3:
+$Jeannot: tnc.c,v 1.205 2005/01/28 18:27:31 js Exp $
+
+Modifications by David Cortes for inclusion in poismf library (2020)