Skip to content

Commit

Permalink
update release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
teddy.chao committed Jan 17, 2024
1 parent 1cf1f0e commit 769ac99
Show file tree
Hide file tree
Showing 2 changed files with 118 additions and 1 deletion.
Binary file modified doc/release_notes.pdf
Binary file not shown.
119 changes: 118 additions & 1 deletion doc/release_notes.tex
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
framexleftmargin=1pt,
frame=l}
\renewcommand{\lstlistingname}{Listing}
\title{PsPM Release Notes\\ ~\\ Version 6.1.0}
\title{PsPM Release Notes\\ ~\\ Version 6.1.1}

\begin{document}
\maketitle
Expand Down Expand Up @@ -1096,6 +1096,123 @@ \subsection*{Reference document}
\item New document \textit{PsPM Reference} for checking the default values and restrictions of \texttt{options} fields.
\end{itemize}

\section{PsPM Version 6.1.1}

\subsection*{New features}
\begin{itemize}
\item \texttt{pspm\_bf\_psrf\_2\_fc}
\begin{itemize}
\item \texttt{pspm\_bf\_psrf\_2\_fc} now allows to set the time delay between
CS and US.
\item Previously, \texttt{pspm\_bf\_psrf\_2\_fc} used to set a basis function
for the CS and for the US response with a time delay of 3.5 s as standard.
\end{itemize}
\item \texttt{pspm\_dcm}
\begin{itemize}
\item Missing data epochs from file and data can be combined.
\end{itemize}
\item \texttt{pspm\_glm}
\begin{itemize}
\item \texttt{pspm\_glm} now allows a two-element vector and construct the
dictionary accordingly.
\item Previously \texttt{pspm\_glm} only allows scalar values in model.window.
\end{itemize}
\end{itemize}

\subsection*{New functions}
\begin{itemize}
\item \texttt{pspm\_check\_model}
\begin{itemize}
\item \texttt{pspm\_check\_model} checks the fiels of models.
\end{itemize}
\item \texttt{pspm\_combine\_markerchannels}
\begin{itemize}
\item \texttt{pspm\_combine\_markerchannels} allows users to use the GLM
option \textquotedbl markervalues\textquotedbl{} to create onsets
definition from channels distributed across multiple channels.
\end{itemize}
\item \texttt{pspm\_tam}
\begin{itemize}
\item \texttt{TAM} stands for Trial Average Model. \texttt{pspm\_tam} allows
to fit models on trial-averaged data.
\end{itemize}
\end{itemize}

\subsection*{Adjustments}
\begin{itemize}
\item \texttt{pspm\_pupil\_pp}
\begin{itemize}
\item Now \texttt{pspm\_pupil\_pp} creates channels of type \texttt{pupil}
rather than \texttt{pupil\_pp}.
\end{itemize}
\item \texttt{pspm\_split\_sessions}
\begin{itemize}
\item \texttt{pspm\_split\_sessions} no longer drops markers at beginning
or end of file.
\end{itemize}
\end{itemize}

\subsection*{Bug fixes}
\begin{itemize}
\item \texttt{pspm\_con}
\begin{itemize}
\item A bug caused by the new varargout logic of \texttt{pspm\_load1} has
been fixed.
\end{itemize}
\item \texttt{pspm\_dcm}
\begin{itemize}
\item A bug that leads dropping sub-threshold missing data periods has been
fixed.
\end{itemize}
\item \texttt{pspm\_get\_spike}
\begin{itemize}
\item A minor bug caused by a non-existing variable has been fxied.
\end{itemize}
\item \texttt{pspm\_scr\_pp}
\begin{itemize}
\item A bug that could change the original file if it saves epochs to \texttt{missing\_epoch.mat}
has been fixed.
\end{itemize}
\end{itemize}

\subsection*{Improvements}
\begin{itemize}
\item \texttt{pspm\_extract\_segments}
\begin{itemize}
\item Now \texttt{pspm\_extract\_segments} process the data after excluding
the missing data information that is provided in the model structure.
\end{itemize}
\item \texttt{pspm\_dcm}
\begin{itemize}
\item Processed data are now initialised as data matrix with \texttt{NaN}
before inserting data of variable size.
\end{itemize}
\item \texttt{pspm\_glm}
\begin{itemize}
\item A warning has been added if any duration in onset definition is above
\texttt{0} and modality is not \texttt{sps}.
\end{itemize}
\item \texttt{pspm\_overwrite}
\begin{itemize}
\item The logic of overwriting files in PsPM has been updated.
\item Specifically, the overwriting operation is applicable only if there
has been a file with the proposed name of the outputfile.
\item A warning will be provided if the user chooses not to overwrite the
file, since the output of PsPM will not be saved.
\end{itemize}
\item \texttt{pspm\_split\_sessions}
\begin{itemize}
\item A misleading warning provided by \texttt{pspm\_split\_sessions} when
it processes a missing epoch file has been fixed.
\item The help text of \texttt{split\_sessions} in the GUI has been updated.
\end{itemize}
\end{itemize}

\subsection*{UI improvements}
\begin{itemize}
\item PsPM's UI in Linux environment has been improved.
\end{itemize}

\bibliographystyle{pnas2009}
\bibliography{PsPM}

Expand Down

0 comments on commit 769ac99

Please sign in to comment.