updated docs

mllg · Feb 25, 2016 · 4b4cfe1 · 4b4cfe1
1 parent 735bca2
commit 4b4cfe1
Show file tree

Hide file tree

Showing 52 changed files with 434 additions and 157 deletions.
diff --git a/inst/web/AssertCollection.html b/inst/web/AssertCollection.html
@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-<title>AssertCollection. checkmate 1.7.1</title>
+<title>AssertCollection. checkmate 1.7.2</title>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="author" content="">
 
@@ -32,7 +32,7 @@
     <div class="navbar">
   <div class="navbar-inner">
     <div class="container">
-      <a class="brand" href="#">checkmate 1.7.1</a>
+      <a class="brand" href="#">checkmate 1.7.2</a>
       <div class="nav">
         <ul class="nav">
           <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>

diff --git a/inst/web/anyInfinite.html b/inst/web/anyInfinite.html
@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-<title>anyInfinite. checkmate 1.7.1</title>
+<title>anyInfinite. checkmate 1.7.2</title>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="author" content="">
 
@@ -32,7 +32,7 @@
     <div class="navbar">
   <div class="navbar-inner">
     <div class="container">
-      <a class="brand" href="#">checkmate 1.7.1</a>
+      <a class="brand" href="#">checkmate 1.7.2</a>
       <div class="nav">
         <ul class="nav">
           <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>

diff --git a/inst/web/anyMissing.html b/inst/web/anyMissing.html
@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-<title>allMissing. checkmate 1.7.1</title>
+<title>allMissing. checkmate 1.7.2</title>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="author" content="">
 
@@ -32,7 +32,7 @@
     <div class="navbar">
   <div class="navbar-inner">
     <div class="container">
-      <a class="brand" href="#">checkmate 1.7.1</a>
+      <a class="brand" href="#">checkmate 1.7.2</a>
       <div class="nav">
         <ul class="nav">
           <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>

diff --git a/inst/web/anyNaN.html b/inst/web/anyNaN.html
@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-<title>anyNaN. checkmate 1.7.1</title>
+<title>anyNaN. checkmate 1.7.2</title>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="author" content="">
 
@@ -32,7 +32,7 @@
     <div class="navbar">
   <div class="navbar-inner">
     <div class="container">
-      <a class="brand" href="#">checkmate 1.7.1</a>
+      <a class="brand" href="#">checkmate 1.7.2</a>
       <div class="nav">
         <ul class="nav">
           <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>

diff --git a/inst/web/asInteger.html b/inst/web/asInteger.html
@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-<title>asInteger. checkmate 1.7.1</title>
+<title>asInteger. checkmate 1.7.2</title>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="author" content="">
 
@@ -32,7 +32,7 @@
     <div class="navbar">
   <div class="navbar-inner">
     <div class="container">
-      <a class="brand" href="#">checkmate 1.7.1</a>
+      <a class="brand" href="#">checkmate 1.7.2</a>
       <div class="nav">
         <ul class="nav">
           <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>

diff --git a/inst/web/assert.html b/inst/web/assert.html
@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-<title>assert. checkmate 1.7.1</title>
+<title>assert. checkmate 1.7.2</title>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="author" content="">
 
@@ -32,7 +32,7 @@
     <div class="navbar">
   <div class="navbar-inner">
     <div class="container">
-      <a class="brand" href="#">checkmate 1.7.1</a>
+      <a class="brand" href="#">checkmate 1.7.2</a>
       <div class="nav">
         <ul class="nav">
           <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>

diff --git a/inst/web/checkAccess.html b/inst/web/checkAccess.html
@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-<title>checkAccess. checkmate 1.7.1</title>
+<title>checkAccess. checkmate 1.7.2</title>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="author" content="">
 
@@ -32,7 +32,7 @@
     <div class="navbar">
   <div class="navbar-inner">
     <div class="container">
-      <a class="brand" href="#">checkmate 1.7.1</a>
+      <a class="brand" href="#">checkmate 1.7.2</a>
       <div class="nav">
         <ul class="nav">
           <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>

diff --git a/inst/web/checkArray.html b/inst/web/checkArray.html
@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-<title>checkArray. checkmate 1.7.1</title>
+<title>checkArray. checkmate 1.7.2</title>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="author" content="">
 
@@ -32,7 +32,7 @@
     <div class="navbar">
   <div class="navbar-inner">
     <div class="container">
-      <a class="brand" href="#">checkmate 1.7.1</a>
+      <a class="brand" href="#">checkmate 1.7.2</a>
       <div class="nav">
         <ul class="nav">
           <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>

diff --git a/inst/web/checkAtomic.html b/inst/web/checkAtomic.html
@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-<title>checkAtomic. checkmate 1.7.1</title>
+<title>checkAtomic. checkmate 1.7.2</title>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="author" content="">
 
@@ -32,7 +32,7 @@
     <div class="navbar">
   <div class="navbar-inner">
     <div class="container">
-      <a class="brand" href="#">checkmate 1.7.1</a>
+      <a class="brand" href="#">checkmate 1.7.2</a>
       <div class="nav">
         <ul class="nav">
           <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>

diff --git a/inst/web/checkAtomicVector.html b/inst/web/checkAtomicVector.html
@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-<title>checkAtomicVector. checkmate 1.7.1</title>
+<title>checkAtomicVector. checkmate 1.7.2</title>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="author" content="">
 
@@ -32,7 +32,7 @@
     <div class="navbar">
   <div class="navbar-inner">
     <div class="container">
-      <a class="brand" href="#">checkmate 1.7.1</a>
+      <a class="brand" href="#">checkmate 1.7.2</a>
       <div class="nav">
         <ul class="nav">
           <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>

diff --git a/inst/web/checkCharacter.html b/inst/web/checkCharacter.html
@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-<title>checkCharacter. checkmate 1.7.1</title>
+<title>checkCharacter. checkmate 1.7.2</title>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="author" content="">
 
@@ -32,7 +32,7 @@
     <div class="navbar">
   <div class="navbar-inner">
     <div class="container">
-      <a class="brand" href="#">checkmate 1.7.1</a>
+      <a class="brand" href="#">checkmate 1.7.2</a>
       <div class="nav">
         <ul class="nav">
           <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>
@@ -52,12 +52,12 @@ <h1>Check if an argument is a vector of type character</h1>
 <div class="row">
   <div class="span8">
     <h2>Usage</h2>
-    <pre><div>checkCharacter(x, min.chars&nbsp;=&nbsp;NULL, pattern&nbsp;=&nbsp;NULL, fixed&nbsp;=&nbsp;FALSE, ignore.case&nbsp;=&nbsp;FALSE, any.missing&nbsp;=&nbsp;TRUE, all.missing&nbsp;=&nbsp;TRUE, len&nbsp;=&nbsp;NULL, min.len&nbsp;=&nbsp;NULL, max.len&nbsp;=&nbsp;NULL, unique&nbsp;=&nbsp;FALSE, names&nbsp;=&nbsp;NULL)</div>
-<div>assertCharacter(x, min.chars&nbsp;=&nbsp;NULL, pattern&nbsp;=&nbsp;NULL, fixed&nbsp;=&nbsp;FALSE, ignore.case&nbsp;=&nbsp;FALSE, any.missing&nbsp;=&nbsp;TRUE, all.missing&nbsp;=&nbsp;TRUE, len&nbsp;=&nbsp;NULL, min.len&nbsp;=&nbsp;NULL, max.len&nbsp;=&nbsp;NULL, unique&nbsp;=&nbsp;FALSE, names&nbsp;=&nbsp;NULL, add&nbsp;=&nbsp;NULL, .var.name)</div>
-<div>assert_character(x, min.chars&nbsp;=&nbsp;NULL, pattern&nbsp;=&nbsp;NULL, fixed&nbsp;=&nbsp;FALSE, ignore.case&nbsp;=&nbsp;FALSE, any.missing&nbsp;=&nbsp;TRUE, all.missing&nbsp;=&nbsp;TRUE, len&nbsp;=&nbsp;NULL, min.len&nbsp;=&nbsp;NULL, max.len&nbsp;=&nbsp;NULL, unique&nbsp;=&nbsp;FALSE, names&nbsp;=&nbsp;NULL, add&nbsp;=&nbsp;NULL, .var.name)</div>
-<div>testCharacter(x, min.chars&nbsp;=&nbsp;NULL, pattern&nbsp;=&nbsp;NULL, fixed&nbsp;=&nbsp;FALSE, ignore.case&nbsp;=&nbsp;FALSE, any.missing&nbsp;=&nbsp;TRUE, all.missing&nbsp;=&nbsp;TRUE, len&nbsp;=&nbsp;NULL, min.len&nbsp;=&nbsp;NULL, max.len&nbsp;=&nbsp;NULL, unique&nbsp;=&nbsp;FALSE, names&nbsp;=&nbsp;NULL)</div>
-<div>test_character(x, min.chars&nbsp;=&nbsp;NULL, pattern&nbsp;=&nbsp;NULL, fixed&nbsp;=&nbsp;FALSE, ignore.case&nbsp;=&nbsp;FALSE, any.missing&nbsp;=&nbsp;TRUE, all.missing&nbsp;=&nbsp;TRUE, len&nbsp;=&nbsp;NULL, min.len&nbsp;=&nbsp;NULL, max.len&nbsp;=&nbsp;NULL, unique&nbsp;=&nbsp;FALSE, names&nbsp;=&nbsp;NULL)</div>
-<div>expect_character(x, min.chars&nbsp;=&nbsp;NULL, pattern&nbsp;=&nbsp;NULL, fixed&nbsp;=&nbsp;FALSE, ignore.case&nbsp;=&nbsp;FALSE, any.missing&nbsp;=&nbsp;TRUE, all.missing&nbsp;=&nbsp;TRUE, len&nbsp;=&nbsp;NULL, min.len&nbsp;=&nbsp;NULL, max.len&nbsp;=&nbsp;NULL, unique&nbsp;=&nbsp;FALSE, names&nbsp;=&nbsp;NULL, info&nbsp;=&nbsp;NULL, label&nbsp;=&nbsp;NULL)</div></pre>
+    <pre><div>checkCharacter(x, min.chars&nbsp;=&nbsp;NULL, pattern&nbsp;=&nbsp;NULL, fixed&nbsp;=&nbsp;NULL, ignore.case&nbsp;=&nbsp;FALSE, any.missing&nbsp;=&nbsp;TRUE, all.missing&nbsp;=&nbsp;TRUE, len&nbsp;=&nbsp;NULL, min.len&nbsp;=&nbsp;NULL, max.len&nbsp;=&nbsp;NULL, unique&nbsp;=&nbsp;FALSE, names&nbsp;=&nbsp;NULL)</div>
+<div>assertCharacter(x, min.chars&nbsp;=&nbsp;NULL, pattern&nbsp;=&nbsp;NULL, fixed&nbsp;=&nbsp;NULL, ignore.case&nbsp;=&nbsp;FALSE, any.missing&nbsp;=&nbsp;TRUE, all.missing&nbsp;=&nbsp;TRUE, len&nbsp;=&nbsp;NULL, min.len&nbsp;=&nbsp;NULL, max.len&nbsp;=&nbsp;NULL, unique&nbsp;=&nbsp;FALSE, names&nbsp;=&nbsp;NULL, add&nbsp;=&nbsp;NULL, .var.name)</div>
+<div>assert_character(x, min.chars&nbsp;=&nbsp;NULL, pattern&nbsp;=&nbsp;NULL, fixed&nbsp;=&nbsp;NULL, ignore.case&nbsp;=&nbsp;FALSE, any.missing&nbsp;=&nbsp;TRUE, all.missing&nbsp;=&nbsp;TRUE, len&nbsp;=&nbsp;NULL, min.len&nbsp;=&nbsp;NULL, max.len&nbsp;=&nbsp;NULL, unique&nbsp;=&nbsp;FALSE, names&nbsp;=&nbsp;NULL, add&nbsp;=&nbsp;NULL, .var.name)</div>
+<div>testCharacter(x, min.chars&nbsp;=&nbsp;NULL, pattern&nbsp;=&nbsp;NULL, fixed&nbsp;=&nbsp;NULL, ignore.case&nbsp;=&nbsp;FALSE, any.missing&nbsp;=&nbsp;TRUE, all.missing&nbsp;=&nbsp;TRUE, len&nbsp;=&nbsp;NULL, min.len&nbsp;=&nbsp;NULL, max.len&nbsp;=&nbsp;NULL, unique&nbsp;=&nbsp;FALSE, names&nbsp;=&nbsp;NULL)</div>
+<div>test_character(x, min.chars&nbsp;=&nbsp;NULL, pattern&nbsp;=&nbsp;NULL, fixed&nbsp;=&nbsp;NULL, ignore.case&nbsp;=&nbsp;FALSE, any.missing&nbsp;=&nbsp;TRUE, all.missing&nbsp;=&nbsp;TRUE, len&nbsp;=&nbsp;NULL, min.len&nbsp;=&nbsp;NULL, max.len&nbsp;=&nbsp;NULL, unique&nbsp;=&nbsp;FALSE, names&nbsp;=&nbsp;NULL)</div>
+<div>expect_character(x, min.chars&nbsp;=&nbsp;NULL, pattern&nbsp;=&nbsp;NULL, fixed&nbsp;=&nbsp;NULL, ignore.case&nbsp;=&nbsp;FALSE, any.missing&nbsp;=&nbsp;TRUE, all.missing&nbsp;=&nbsp;TRUE, len&nbsp;=&nbsp;NULL, min.len&nbsp;=&nbsp;NULL, max.len&nbsp;=&nbsp;NULL, unique&nbsp;=&nbsp;FALSE, names&nbsp;=&nbsp;NULL, info&nbsp;=&nbsp;NULL, label&nbsp;=&nbsp;NULL)</div></pre>
 
     <h2>Arguments</h2>
     <dl>
@@ -70,11 +70,12 @@ <h2>Arguments</h2>
       <dt>pattern</dt>
       <dd>[<code>character(1L)</code>]
 Regular expression as used in <code><a href='http://www.inside-r.org/r-doc/base/grep'>grepl</a></code>.
-All elements of <code>x</code> must comply to this pattern.
-Defaults to <code>NULL</code>.</dd>
+All elements of <code>x</code> must comply to this pattern.</dd>
       <dt>fixed</dt>
-      <dd>[<code>logical(1)</code>]
-See <code><a href='http://www.inside-r.org/r-doc/base/grep'>grepl</a></code>. Default is <code>FALSE</code>.</dd>
+      <dd>[<code>character(1)</code>]
+Substring to detect in <code>x</code>. Will be used as <code>pattern</code> in <code><a href='http://www.inside-r.org/r-doc/base/grep'>grepl</a></code>
+with option <code>fixed</code> set to <code>TRUE</code>.
+All elements of <code>x</code> must contain this substring.</dd>
       <dt>ignore.case</dt>
       <dd>[<code>logical(1)</code>]
 See <code><a href='http://www.inside-r.org/r-doc/base/grep'>grepl</a></code>. Default is <code>FALSE</code>.</dd>

diff --git a/inst/web/checkChoice.html b/inst/web/checkChoice.html
@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-<title>checkChoice. checkmate 1.7.1</title>
+<title>checkChoice. checkmate 1.7.2</title>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="author" content="">
 
@@ -32,7 +32,7 @@
     <div class="navbar">
   <div class="navbar-inner">
     <div class="container">
-      <a class="brand" href="#">checkmate 1.7.1</a>
+      <a class="brand" href="#">checkmate 1.7.2</a>
       <div class="nav">
         <ul class="nav">
           <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>

diff --git a/inst/web/checkClass.html b/inst/web/checkClass.html
@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-<title>checkClass. checkmate 1.7.1</title>
+<title>checkClass. checkmate 1.7.2</title>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="author" content="">
 
@@ -32,7 +32,7 @@
     <div class="navbar">
   <div class="navbar-inner">
     <div class="container">
-      <a class="brand" href="#">checkmate 1.7.1</a>
+      <a class="brand" href="#">checkmate 1.7.2</a>
       <div class="nav">
         <ul class="nav">
           <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>

diff --git a/inst/web/checkComplex.html b/inst/web/checkComplex.html
@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-<title>checkComplex. checkmate 1.7.1</title>
+<title>checkComplex. checkmate 1.7.2</title>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="author" content="">
 
@@ -32,7 +32,7 @@
     <div class="navbar">
   <div class="navbar-inner">
     <div class="container">
-      <a class="brand" href="#">checkmate 1.7.1</a>
+      <a class="brand" href="#">checkmate 1.7.2</a>
       <div class="nav">
         <ul class="nav">
           <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>

diff --git a/inst/web/checkCount.html b/inst/web/checkCount.html
@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-<title>checkCount. checkmate 1.7.1</title>
+<title>checkCount. checkmate 1.7.2</title>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="author" content="">
 
@@ -32,7 +32,7 @@
     <div class="navbar">
   <div class="navbar-inner">
     <div class="container">
-      <a class="brand" href="#">checkmate 1.7.1</a>
+      <a class="brand" href="#">checkmate 1.7.2</a>
       <div class="nav">
         <ul class="nav">
           <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>

diff --git a/inst/web/checkDataFrame.html b/inst/web/checkDataFrame.html
@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-<title>checkDataFrame. checkmate 1.7.1</title>
+<title>checkDataFrame. checkmate 1.7.2</title>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="author" content="">
 
@@ -32,7 +32,7 @@
     <div class="navbar">
   <div class="navbar-inner">
     <div class="container">
-      <a class="brand" href="#">checkmate 1.7.1</a>
+      <a class="brand" href="#">checkmate 1.7.2</a>
       <div class="nav">
         <ul class="nav">
           <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>

diff --git a/inst/web/checkDataTable.html b/inst/web/checkDataTable.html
@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-<title>checkDataTable. checkmate 1.7.1</title>
+<title>checkDataTable. checkmate 1.7.2</title>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="author" content="">
 
@@ -32,7 +32,7 @@
     <div class="navbar">
   <div class="navbar-inner">
     <div class="container">
-      <a class="brand" href="#">checkmate 1.7.1</a>
+      <a class="brand" href="#">checkmate 1.7.2</a>
       <div class="nav">
         <ul class="nav">
           <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>

diff --git a/inst/web/checkDirectory.html b/inst/web/checkDirectory.html
@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-<title>checkDirectory. checkmate 1.7.1</title>
+<title>checkDirectory. checkmate 1.7.2</title>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="author" content="">
 
@@ -32,7 +32,7 @@
     <div class="navbar">
   <div class="navbar-inner">
     <div class="container">
-      <a class="brand" href="#">checkmate 1.7.1</a>
+      <a class="brand" href="#">checkmate 1.7.2</a>
       <div class="nav">
         <ul class="nav">
           <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>

diff --git a/inst/web/checkEnvironment.html b/inst/web/checkEnvironment.html
@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-<title>checkEnvironment. checkmate 1.7.1</title>
+<title>checkEnvironment. checkmate 1.7.2</title>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="author" content="">
 
@@ -32,7 +32,7 @@
     <div class="navbar">
   <div class="navbar-inner">
     <div class="container">
-      <a class="brand" href="#">checkmate 1.7.1</a>
+      <a class="brand" href="#">checkmate 1.7.2</a>
       <div class="nav">
         <ul class="nav">
           <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>

diff --git a/inst/web/checkFactor.html b/inst/web/checkFactor.html
@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-<title>checkFactor. checkmate 1.7.1</title>
+<title>checkFactor. checkmate 1.7.2</title>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="author" content="">
 
@@ -32,7 +32,7 @@
     <div class="navbar">
   <div class="navbar-inner">
     <div class="container">
-      <a class="brand" href="#">checkmate 1.7.1</a>
+      <a class="brand" href="#">checkmate 1.7.2</a>
       <div class="nav">
         <ul class="nav">
           <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>