Skip to content

Commit

Permalink
Allowing plot legend to be adjusted (#384)
Browse files Browse the repository at this point in the history
* Allowing plot legend to be adjusted

* Synchronized script and command line
  • Loading branch information
kjvbrt committed Jul 3, 2024
1 parent d72a716 commit 5f59bd1
Show file tree
Hide file tree
Showing 4 changed files with 265 additions and 106 deletions.
73 changes: 73 additions & 0 deletions man/man1/fccanalysis-plots.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
.\" Manpage for fccanalysis-plots
.\" Contact [email protected] to correct errors or typos.
.TH FCCANALYSIS\-PLOTS 1 "28 Jun 2024" "0.9.0" "fccanalysis-plots man page"
.SH NAME
\fBfccanalysis\-plots\fR \(en generate analysis plots
.SH SYNOPSIS
.B fccanalysis plots
[\fB\-h\fR | \fB\-\-help\fR]
[\fB\-\-legend-text-size\fR \fILEGEND_TEXT_SIZE\fR]
[\fB\-\-legend-x-min\fR \fILEGEND_X_MIN\fR]
[\fB\-\-legend-x-max\fR \fILEGEND_X_MAX\fR]
[\fB\-\-legend-y-min\fR \fILEGEND_Y_MIN\fR]
[\fB\-\-legend-y-max\fR \fILEGEND_Y_MAX\fR]
.I plots-script
.SH DESCRIPTION
.B fccanalysis\-plots
is FCCAnalyses sub-command to generate plots out of histograms created in the
previous stages of the analysis\&.
.SH OPTIONS
.TP
.BR \-h ", " \-\-help
Prints short help message and exits\&.
.TP
.BR \-c ", " \-\-clean\-plots
Completely clean plots directory before compilation\&.
.TP
\fB\-\-legend\-text\-size\fR \fILEGEND_TEXT_SIZE\fR
Specify text size for the legend elements\&. The default value is: 0.035\&.
.TP
\fB\-\-legend\-x\-min\fR \fILEGEND_X_MIN\fR
Specify minimal x position of the legend\&. The default value: automatic\&.
.TP
\fB--legend-x-max\fR \fILEGEND_X_MAX\fR
Specify maximal x position of the legend\&. The default value: automatic\&.
.TP
\fB--legend-y-min\fR \fILEGEND_Y_MIN\fR
Specify minimal y position of the legend\&. The default value: automatic\&.
.TP
\fB--legend-y-max\fR \fILEGEND_Y_MAX\fR
Specify maximal y position of the legend\&. The default value: automatic\&.
.SH SEE ALSO
fccanalysis(1), fccanalysis\-run(1), fccanalysis\-final(1)
.SH BUGS
Many
.SH AUTHORS
There are many contributors to the FCCAnalyses framework, but the principal
authors are:
.in +4
Clement Helsens
.br
Valentin Volk
.br
Gerardo Ganis
.SH FCCANALYSES
Part of the FCCAnalyses framework\&.
.SH LINKS
.PP
.UR https://hep-fcc\&.github\&.io/FCCAnalyses/
FCCAnalyses webpage
.UE
.PP
.UR https://github\&.com/HEP\-FCC/FCCAnalyses/
FCCAnalysises GitHub repository
.UE
.PP
.UR https://fccsw\-forum\&.web\&.cern\&.ch/
FCCSW Forum
.UE
.SH CONTACT
.pp
.MT [email protected]
FCC-PED-SoftwareAndComputing-Analysis
.ME
2 changes: 1 addition & 1 deletion man/man1/fccanalysis-run.1
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
[\fB\-\-graph\-path\fR \fIGRAPH_PATH\fR]
.I analysis-script
.SH DESCRIPTION
.B fccanalysis-run
.B fccanalysis\-run
will run analysis provided in the analysis file\&. The
analysis itself can be divided into several stages if desired\&. For all those
stages \fIfccanalysis-run\fR is used\&.
Expand Down
Loading

0 comments on commit 5f59bd1

Please sign in to comment.