Skip to content

Commit

Permalink
Minor documentation updates
Browse files Browse the repository at this point in the history
git-svn-id: svn://scm.r-forge.r-project.org/svnroot/chnosz/pkg/CHNOSZ@806 edb9625f-4e0d-4859-8d74-9fd3b1da38cb
  • Loading branch information
jedick committed Sep 19, 2023
1 parent 7c2a650 commit 23ea637
Show file tree
Hide file tree
Showing 4 changed files with 82 additions and 79 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Date: 2023-09-14
Date: 2023-09-19
Package: CHNOSZ
Version: 2.0.0-25
Version: 2.0.0-26
Title: Thermodynamic Calculations and Diagrams for Geochemistry
Authors@R: c(
person("Jeffrey", "Dick", , "[email protected]", role = c("aut", "cre"),
Expand Down
19 changes: 11 additions & 8 deletions inst/NEWS.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@
% links to vignettes 20220723
\newcommand{\viglink}{\ifelse{html}{\out{<a href="../CHNOSZ/doc/#1.html"><strong>#1.Rmd</strong></a>}}{\bold{#1.Rmd}}}

\section{Changes in CHNOSZ version 2.0.0-24 (2023-09-11)}{
\section{Changes in CHNOSZ version 2.0.0-26 (2023-09-19)}{

\itemize{

\item Add FAQ vignette with the following questions:
\item Add \viglink{FAQ} vignette with the following questions:

\itemize{

Expand All @@ -34,17 +34,20 @@
in the FAQ (\dQuote{How can minerals with phase transitions be added to
the database?}).

\item Restore \file{EOSregress.R}, \file{eos-regress.Rmd}, and
\file{demo/adenine.R}.
\item Restore \file{EOSregress.R} and its reverse dependencies
\file{eos-regress.Rmd} and \file{demo/adenine.R}. Thanks to Kris Fecteau
and Kirt Robinson for the suggestion.

\item Rename \code{checkGHS()} and \code{checkEOS()} to
\code{check.GHS()} and \code{check.EOS()} and make
\code{return.difference} TRUE by default.

\item Where the alternate basis species include one of the axis variables
on a diagram, \code{mosaic()} now calls \code{affinity()} with the
appropriate argument names and adjusts the labels for the diagram
(\dQuote{total C}, \dQuote{total S}, etc.).
\item \code{mosaic()} now handles the situation where the alternate basis
species include one of the axis variables on a diagram (by changing the
argument names in its internal calls to \code{affinity()}) and
adjusts the labels for the diagram accordingly (e.g. \dQuote{total C},
\dQuote{total S}, etc.). Thanks to Evgeniy Bastrakov for the feature
request.

\item Fix bug in \code{subcrt()} for \code{exceed.Ttr} not applied to
automatically balanced reactions (it was stuck on FALSE regardless of the
Expand Down
6 changes: 3 additions & 3 deletions vignettes/FAQ.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -168,9 +168,9 @@ CHNOSZ and [schnoz](https://en.wiktionary.org/wiki/schnozz) are homophones.

## How should CHNOSZ be cited?

* Cite this paper as the general reference for CHNOSZ: @Dic19.
* Cite this paper for diagrams with multiple metals: @Dic21b.
* Cite this paper for metastable equilibrium calculations for proteins: @Dic08.
* This paper is the general reference for CHNOSZ: @Dic19.
* This paper describes diagrams with multiple metals: @Dic21b.
* This paper describes metastable equilibrium calculations for proteins: @Dic08.
* The [<span style="color:blue">*OBIGT thermodynamic database*</span>](OBIGT.html) represents the work of many researchers.
**If you publish results that depend on any of these data, please cite the primary sources.**
Use `r info_` to show the reference keys for particular species and `r thermo.refs_` to list the bibliographic details:
Expand Down
Loading

0 comments on commit 23ea637

Please sign in to comment.