Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Small documentation fixes #27

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions R/DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ Author: Ben Hamner <[email protected]>
License: BSD
Collate:
'metrics.r'
RoxygenNote: 5.0.1
14 changes: 8 additions & 6 deletions R/NAMESPACE
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
# Generated by roxygen2: do not edit by hand

export(MeanQuadraticWeightedKappa)
export(ScoreQuadraticWeightedKappa)
export(ae)
export(apk)
export(auc)
export(ce)
export(f1)
export(ll)
export(logLoss)
export(mae)
export(mapk)
export(MeanQuadraticWeightedKappa)
export(mse)
export(msle)
export(rae)
export(rmse)
export(rmsle)
export(ScoreQuadraticWeightedKappa)
export(rrse)
export(rse)
export(se)
export(sle)
export(rse)
export(rrse)
export(rae)
export(f1)
8 changes: 4 additions & 4 deletions R/R/metrics.r
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
#' @export
se <- function (actual, predicted) (actual-predicted)^2

#' Compute the mean squared error#'
#' Compute the mean squared error
#' This function computes the mean squared error between
#' two vectors
#'
Expand All @@ -17,7 +17,7 @@ se <- function (actual, predicted) (actual-predicted)^2
#' @export
mse <- function (actual, predicted) mean(se(actual, predicted))

#' Compute the root mean squared error#'
#' Compute the root mean squared error
#' This function computes the root mean squared error
#' between two vectors
#'
Expand All @@ -26,7 +26,7 @@ mse <- function (actual, predicted) mean(se(actual, predicted))
#' @export
rmse <- function (actual, predicted) sqrt(mse(actual, predicted))

#' Compute the absolute error#'
#' Compute the absolute error
#' This function computes the elementwise absolute error for a
#' number or a vector
#'
Expand All @@ -35,7 +35,7 @@ rmse <- function (actual, predicted) sqrt(mse(actual, predicted))
#' @export
ae <- function (actual, predicted) abs(actual-predicted)

#' Compute the mean absolute error#'
#' Compute the mean absolute error
#' This function computes the mean absolte error between
#' two vectors
#'
Expand Down
12 changes: 7 additions & 5 deletions R/man/MeanQuadraticWeightedKappa.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 9 additions & 8 deletions R/man/ScoreQuadraticWeightedKappa.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 9 additions & 6 deletions R/man/ae.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 8 additions & 6 deletions R/man/apk.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 7 additions & 6 deletions R/man/auc.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 7 additions & 5 deletions R/man/ce.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 13 additions & 7 deletions R/man/f1.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 7 additions & 5 deletions R/man/ll.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 7 additions & 5 deletions R/man/logLoss.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 9 additions & 6 deletions R/man/mae.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 8 additions & 6 deletions R/man/mapk.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 9 additions & 6 deletions R/man/mse.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading