Updated documentation

neuroimaginador · Apr 24, 2023 · 5c3a278 · 5c3a278
1 parent 010acb4
commit 5c3a278
Show file tree

Hide file tree

Showing 50 changed files with 146 additions and 98 deletions.
diff --git a/.gitignore b/.gitignore
@@ -13,3 +13,4 @@ CRAN-RELEASE
 doc
 /doc/
 /Meta/
+check
diff --git a/NEWS.md b/NEWS.md
@@ -1,4 +1,4 @@
-# fcaR 1.2.0
+# fcaR 1.2.1
 
 Enhancements:
 
@@ -10,6 +10,11 @@ Bugfixes:
 * Fixes required by the new version of Matrix and the new use of HTML Tidy in R 4.2.
 * Some rounding errors might induce errors in the computations. These has been fixed.
 
+# fcaR 1.2.0
+
+* Fixes required by the new version of Matrix and the new use of HTML Tidy in R 4.2.
+
+
 # fcaR 1.1.1
 
 Enhancements:

diff --git a/README.Rmd b/README.Rmd
@@ -152,6 +152,17 @@ For more details on the methods implemented and further examples, see the vignet
 
 With respect to the CRAN version, the development version has the following changes.
 
+# fcaR 1.2.1
+
+Enhancements:
+
+* Other logics have been implemented. Now, we can use `fc$use_logic()` to select one of the `available_logics()`.
+* Improved export to LaTeX.
+
+Bugfixes:
+
+* Some rounding errors might induce errors in the computations. These has been fixed.
+
 ### fcaR 1.2.0
 
 Bugfixes:

diff --git a/README.md b/README.md
@@ -28,21 +28,21 @@ seamlessly with formal contexts and sets of implications. More
 explicitly, three main classes are implemented, using the
 object-oriented-programming paradigm in R:
 
--   FormalContext encapsulates the definition of a formal context (G, M,
-    I), being G the set of objects, M the set of attributes and I the
-    (fuzzy) relationship matrix, and provides methods to operate on the
-    context using FCA tools.
--   ImplicationSet represents a set of implications over a specific
-    formal context.
--   ConceptLattice represents the set of concepts and their
-    relationships, including methods to operate on the lattice.
+- FormalContext encapsulates the definition of a formal context (G, M,
+  I), being G the set of objects, M the set of attributes and I the
+  (fuzzy) relationship matrix, and provides methods to operate on the
+  context using FCA tools.
+- ImplicationSet represents a set of implications over a specific formal
+  context.
+- ConceptLattice represents the set of concepts and their relationships,
+  including methods to operate on the lattice.
 
 Two additional helper classes are implemented:
 
--   Set is a class solely used for visualization purposes, since it
-    encapsulates in sparse format a (fuzzy) set.
--   Concept encapsulates internally both extent and intent of a formal
-    concept as Set.
+- Set is a class solely used for visualization purposes, since it
+  encapsulates in sparse format a (fuzzy) set.
+- Concept encapsulates internally both extent and intent of a formal
+  concept as Set.
 
 Since fcaR is an extension of the data model in the arules package, most
 of the methods and classes implemented interoperates with the main S4
@@ -297,10 +297,10 @@ fc$implications
 Some fundamental functionalities on the concept lattice associated to
 the formal context have been implemented:
 
--   Computing a sublattice.
--   Calculating the subconcepts and superconcepts of a given concept.
--   Finding the join- and meet- irreducible elements, which allows to
-    reduce the context and find the *standard context*.
+- Computing a sublattice.
+- Calculating the subconcepts and superconcepts of a given concept.
+- Finding the join- and meet- irreducible elements, which allows to
+  reduce the context and find the *standard context*.
 
 Also, one can compute the support of both implications and concepts:
 
@@ -328,8 +328,8 @@ fc$implications$apply_rules(rules = c("composition",
                                       "generalization"))
 #> Processing batch
 #> --> Composition: from 12 to 12 in 0.001 secs.
-#> --> Generalization: from 12 to 12 in 0.001 secs.
-#> Batch took 0.005 secs.
+#> --> Generalization: from 12 to 12 in 0.002 secs.
+#> Batch took 0.004 secs.
 
 # Reduced set of implications
 fc$implications
@@ -358,32 +358,44 @@ the vignettes in this package.
 With respect to the CRAN version, the development version has the
 following changes.
 
+# fcaR 1.2.1
+
+Enhancements:
+
+- Other logics have been implemented. Now, we can use `fc$use_logic()`
+  to select one of the `available_logics()`.
+- Improved export to LaTeX.
+
+Bugfixes:
+
+- Some rounding errors might induce errors in the computations. These
+  has been fixed.
+
 ### fcaR 1.2.0
 
 Bugfixes:
 
--   Fixes required by the new version of Matrix and the new use of HTML
-    Tidy in R 4.2.
+- Fixes required by the new version of Matrix and the new use of HTML
+  Tidy in R 4.2.
 
 ### fcaR 1.1.1
 
 Enhancements:
 
--   The user can control the number of decimal digits when exporting to
-    LaTeX or when printing formal contexts, concept lattices and
-    implications. Just use fcaR_options(decimal_places = n), where n is
-    the number of desired decimal digits.
+- The user can control the number of decimal digits when exporting to
+  LaTeX or when printing formal contexts, concept lattices and
+  implications. Just use fcaR_options(decimal_places = n), where n is
+  the number of desired decimal digits.
 
 New functionality:
 
--   Now the package uses the *settings* package to manage several
-    options. Currently, the only option is the number of decimal digits
-    to use when printing or exporting to LaTeX.
+- Now the package uses the *settings* package to manage several options.
+  Currently, the only option is the number of decimal digits to use when
+  printing or exporting to LaTeX.
 
 Bugfixes:
 
--   Fixed exporting to latex with special characters such as \$, \_,
-    etc.
+- Fixed exporting to latex with special characters such as \$, \_, etc.
 
 ## References
 

diff --git a/doc/implications.html b/doc/implications.html
@@ -975,7 +975,7 @@ <h2>Simplification Logic</h2>
 <div class="sourceCode" id="cb16"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb16-1"><a href="#cb16-1" aria-hidden="true" tabindex="-1"></a>fc_I<span class="sc">$</span>implications<span class="sc">$</span><span class="fu">apply_rules</span>(<span class="at">rules =</span> <span class="fu">c</span>(<span class="st">&quot;composition&quot;</span>,</span>
 <span id="cb16-2"><a href="#cb16-2" aria-hidden="true" tabindex="-1"></a>                                        <span class="st">&quot;simplification&quot;</span>))</span>
 <span id="cb16-3"><a href="#cb16-3" aria-hidden="true" tabindex="-1"></a><span class="co">#&gt; Processing batch</span></span>
-<span id="cb16-4"><a href="#cb16-4" aria-hidden="true" tabindex="-1"></a><span class="co">#&gt; --&gt; Composition: from 12 to 12 in 0.001 secs.</span></span>
+<span id="cb16-4"><a href="#cb16-4" aria-hidden="true" tabindex="-1"></a><span class="co">#&gt; --&gt; Composition: from 12 to 12 in 0 secs.</span></span>
 <span id="cb16-5"><a href="#cb16-5" aria-hidden="true" tabindex="-1"></a><span class="co">#&gt; --&gt; Simplification: from 12 to 12 in 0.008 secs.</span></span>
 <span id="cb16-6"><a href="#cb16-6" aria-hidden="true" tabindex="-1"></a><span class="co">#&gt; Batch took 0.009 secs.</span></span></code></pre></div>
 <p>This enables the reduction of the cardinality and/or the size of the
@@ -1013,7 +1013,7 @@ <h2>Entailment and equivalence of implications</h2>
 <span id="cb18-7"><a href="#cb18-7" aria-hidden="true" tabindex="-1"></a><span class="co">#&gt; Processing batch</span></span>
 <span id="cb18-8"><a href="#cb18-8" aria-hidden="true" tabindex="-1"></a><span class="co">#&gt; --&gt; Simplification: from 10 to 10 in 0.009 secs.</span></span>
 <span id="cb18-9"><a href="#cb18-9" aria-hidden="true" tabindex="-1"></a><span class="co">#&gt; --&gt; Right Simplification: from 10 to 10 in 0.018 secs.</span></span>
-<span id="cb18-10"><a href="#cb18-10" aria-hidden="true" tabindex="-1"></a><span class="co">#&gt; Batch took 0.027 secs.</span></span>
+<span id="cb18-10"><a href="#cb18-10" aria-hidden="true" tabindex="-1"></a><span class="co">#&gt; Batch took 0.028 secs.</span></span>
 <span id="cb18-11"><a href="#cb18-11" aria-hidden="true" tabindex="-1"></a><span class="co"># Any implication in imps2 follows from imps</span></span>
 <span id="cb18-12"><a href="#cb18-12" aria-hidden="true" tabindex="-1"></a>imps <span class="sc">%entails%</span> imps2</span>
 <span id="cb18-13"><a href="#cb18-13" aria-hidden="true" tabindex="-1"></a><span class="co">#&gt;      [,1] [,2] [,3] [,4] [,5] [,6] [,7] [,8] [,9] [,10]</span></span>

diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/CODE_OF_CONDUCT.html b/docs/CODE_OF_CONDUCT.html
diff --git a/docs/CONTRIBUTING.html b/docs/CONTRIBUTING.html
diff --git a/docs/ISSUE_TEMPLATE.html b/docs/ISSUE_TEMPLATE.html
diff --git a/docs/LICENSE.html b/docs/LICENSE.html
diff --git a/docs/SUPPORT.html b/docs/SUPPORT.html
diff --git a/docs/articles/arules.html b/docs/articles/arules.html
diff --git a/docs/articles/concept_lattice.html b/docs/articles/concept_lattice.html
diff --git a/docs/articles/conceptual-scaling.html b/docs/articles/conceptual-scaling.html
diff --git a/docs/articles/extending_equivalence.html b/docs/articles/extending_equivalence.html
diff --git a/docs/articles/implications.html b/docs/articles/implications.html
diff --git a/docs/articles/index.html b/docs/articles/index.html
diff --git a/docs/authors.html b/docs/authors.html