aboutsummaryrefslogtreecommitdiff
path: root/paper.tex
diff options
context:
space:
mode:
authorMohammad Akhlaghi <mohammad@akhlaghi.org>2020-06-02 03:45:46 +0100
committerMohammad Akhlaghi <mohammad@akhlaghi.org>2020-06-06 20:56:39 +0100
commit623ae15c95bb8575b111709705c29b10fcf7c12b (patch)
tree5ea7016e7f81428f9f484458489ef4ba91dffaaa /paper.tex
parentad2b08d9c3f2500449cb28c903930af2c677d534 (diff)
IMPORTANT: Added publication checklist, improved relevant infrastructure
Possible semantic conflicts (that may not show up as Git conflicts but may cause a crash in your project after the merge): 1) The project title (and other basic metadata) should be set in 'reproduce/analysis/conf/metadata.conf'. Please include this file in your merge (if it is ignored because of '.gitattributes'!). 2) Consider importing the changes in 'initialize.mk' and 'verify.mk' (if you have added all analysis Makefiles to the '.gitattributes' file (thus not merging any change in them with your branch). For example with this command: git diff master...maneage -- reproduce/analysis/make/initialize.mk 3) The old 'verify-txt-no-comments-leading-space' function has been replaced by 'verify-txt-no-comments-no-space'. The new function will also remove all white-space characters between the columns (not just white space characters at the start of the line). Thus the resulting check won't involve spacing between columns. A common set of steps are always necessary to prepare a project for publication. Until now, we would simply look at previous submissions and try to follow them, but that was prone to errors and could cause confusion. The internal infrastructure also didn't have some useful features to make good publication possible. Now that the submission of a paper fully devoted to the founding criteria of Maneage is complete (arXiv:2006.03018), it was time to formalize the necessary steps for easier submission of a project using Maneage and implement some low-level features that can make things easier. With this commit a first draft of the publication checklist has been added to 'README-hacking.md', it was tested in the submission of arXiv:2006.03018 and zenodo.3872248. To help guide users on implementing the good practices for output datasets, the outputs of the default project shown in the paper now use the new features). After reading the checklist, please inspect these. Some other relevant changes in this commit: - The publication involves a copy of the necessary software tarballs. Hence a new target ('dist-software') was also added to package all the project's software tarballs in one tarball for easy distribution. - A new 'dist-lzip' target has been defined for those who want to distribute an Lzip-compressed tarball. - The '\includetikz' LaTeX macro now has a second argument to allow configuring the '\includegraphics' call when the plot should not be built, but just imported.
Diffstat (limited to 'paper.tex')
-rw-r--r--paper.tex45
1 files changed, 26 insertions, 19 deletions
diff --git a/paper.tex b/paper.tex
index 967728f..0993e73 100644
--- a/paper.tex
+++ b/paper.tex
@@ -31,7 +31,14 @@
%% LaTeX style file, you will probably not need to set them, and can also
%% replace this "Title and author information" section with the journal's
%% preferred format.
-\title{\large \uppercase{The paper's title goes here}}
+%
+%% NOTE ON TITLE: The title of the project should also be printed as
+%% metadata in all output files. So it is defined with other core project
+%% metadata in 'reproduce/analysis/config/metadata.conf'. That value is
+%% then written in the '\projectitle' LaTeX macro and directly used
+%% here. So please set your project's title in that Makefile with other
+%% basic information.
+\title{\large \uppercase{\projecttitle}}
\author[1]{Your name}
\author[2]{Coauthor one}
\author[1,3]{Coauthor two}
@@ -103,29 +110,29 @@ or
in this way, will let you focus clearly on your science and not have to
worry about fixing this or that number/name in the text.
-Figure \ref{delete-me} shows a simple plot as a demonstration of creating
+Figure \ref{squared} shows a simple plot as a demonstration of creating
plots within \LaTeX{} (using the {\small PGFP}lots package). The minimum
value in this distribution is $\deletememin$, and $\deletememax$ is the
maximum. Take a look into the \LaTeX{} source and you'll see these numbers
are actually macros that were calculated from the same dataset (they will
change if the dataset, or function that produced it, changes).
-The individual {\small PDF} file of Figure \ref{delete-me} is available
-under the \texttt{tex/tikz/} directory of your build directory. You can use
-this PDF file in other contexts (for example in slides showing your
-progress or after publishing the work). If you want to directly use the
-{\small PDF} file in the figure without having to let {\small T}i{\small
- KZ} decide if it should be remade or not, you can also comment the
-\texttt{makepdf} macro at the top of this \LaTeX{} source file.
+The individual {\small PDF} file of Figure \ref{squared} is available under
+the \texttt{tex/tikz/} directory of your build directory. You can use this
+PDF file in other contexts (for example in slides showing your progress or
+after publishing the work). If you want to directly use the {\small PDF}
+file in the figure without having to let {\small T}i{\small KZ} decide if
+it should be remade or not, you can also comment the \texttt{makepdf} macro
+at the top of this \LaTeX{} source file.
\begin{figure}[t]
- \includetikz{delete-me}
+ \includetikz{delete-me-squared}{width=\linewidth}
- \captionof{figure}{\label{delete-me} A very basic $X^2$ plot for
+ \captionof{figure}{\label{squared} A very basic $X^2$ plot for
demonstration.}
\end{figure}
-Figure \ref{delete-me-demo} is another demonstration of showing images
+Figure \ref{image-histogram} is another demonstration of showing images
(datasets) using PGFPlots. It shows a small crop of an image from the
Wide-Field Planetary Camera 2, on board the Hubble Space Telescope from
1993 to 2009. This cropped image is one of the sample FITS files from the
@@ -134,7 +141,7 @@ webpage\footnote{\url{https://fits.gsfc.nasa.gov/fits_samples.html}}. Just
as another basic reporting of measurements on this dataset within the paper
without using numbers in the \LaTeX{} source, the mean is
$\deletemewfpctwomean$ and the median is $\deletemewfpctwomedian$. The
-skewness in the histogram of Figure \ref{delete-me-demo}(b) explains this
+skewness in the histogram of Figure \ref{image-histogram}(b) explains this
difference between the mean and median. The dataset was prepared for
demonstration here with Gnuastro's \textsf{Convert\-Type} program and the
histogram and basic statstics were generated with Gnuastro's
@@ -172,13 +179,13 @@ new co-authors (who don't want to be distracted by these issues in their
first time reading).
\begin{figure}[t]
- \includetikz{delete-me-demo}
+ \includetikz{delete-me-image-histogram}{width=\linewidth}
- \captionof{figure}{\label{delete-me-demo} (a) An example image of the
- Wide-Field Planetary Camera 2, on board the Hubble Space Telescope from
- 1993 to 2009. This is one of the sample images from the FITS standard
- webpage, kept as examples for this file format. (b) Histogram of pixel
- values in (a).}
+ \captionof{figure}{\label{image-histogram} (a) An example image
+ of the Wide-Field Planetary Camera 2, on board the Hubble Space
+ Telescope from 1993 to 2009. This is one of the sample images from the
+ FITS standard webpage, kept as examples for this file format. (b)
+ Histogram of pixel values in (a).}
\end{figure}