Skip to content

Commit

Permalink
Merge pull request #5248 from solgenomics/topic/batch_update_trials
Browse files Browse the repository at this point in the history
Trial Metadata Upload
  • Loading branch information
lukasmueller authored Jan 10, 2025
2 parents 0e5d4bd + a0807fb commit 8518f7a
Show file tree
Hide file tree
Showing 47 changed files with 1,046 additions and 198 deletions.
5 changes: 3 additions & 2 deletions docs/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="Breedbase team" />


<meta name="date" content="2024-07-22" />
<meta name="date" content="2024-12-13" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -185,8 +185,9 @@
<li class="chapter" data-level="10.2.10" data-path="managing-field-trials.html"><a href="managing-field-trials.html#adding-tissue-sample-entries-to-your-trial"><i class="fa fa-check"></i><b>10.2.10</b> Adding Tissue Sample Entries To Your Trial</a></li>
<li class="chapter" data-level="10.2.11" data-path="managing-field-trials.html"><a href="managing-field-trials.html#uploading-gps-coordinates-for-plots"><i class="fa fa-check"></i><b>10.2.11</b> Uploading GPS Coordinates For Plots</a></li>
<li class="chapter" data-level="10.2.12" data-path="managing-field-trials.html"><a href="managing-field-trials.html#uploading-additional-files-to-trial"><i class="fa fa-check"></i><b>10.2.12</b> Uploading Additional Files To Trial</a></li>
<li class="chapter" data-level="10.2.13" data-path="managing-field-trials.html"><a href="managing-field-trials.html#deleting-trial-data"><i class="fa fa-check"></i><b>10.2.13</b> Deleting Trial Data</a></li>
</ul></li>
<li class="chapter" data-level="10.3" data-path="managing-field-trials.html"><a href="managing-field-trials.html#updating-trial-data"><i class="fa fa-check"></i><b>10.3</b> Updating Trial Data</a></li>
<li class="chapter" data-level="10.4" data-path="managing-field-trials.html"><a href="managing-field-trials.html#deleting-trial-data"><i class="fa fa-check"></i><b>10.4</b> Deleting Trial Data</a></li>
</ul></li>
<li class="chapter" data-level="11" data-path="managing-genotyping-plates.html"><a href="managing-genotyping-plates.html"><i class="fa fa-check"></i><b>11</b> Managing Genotyping Plates</a>
<ul>
Expand Down
Binary file modified docs/BreedbaseManual.pdf
Binary file not shown.
43 changes: 41 additions & 2 deletions docs/BreedbaseManual.tex
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@

\title{User Manual of Breedbase}
\author{Breedbase team}
\date{2024-07-22}
\date{2024-12-13}

\begin{document}
\maketitle
Expand Down Expand Up @@ -1752,8 +1752,47 @@ \subsection{Uploading Additional Files To Trial}\label{uploading-additional-file
\begin{center}\includegraphics[width=0.95\linewidth]{assets/images/trial_upload_additional_file_info} \end{center}
\hypertarget{updating-trial-data}{%
\section{Updating Trial Data}\label{updating-trial-data}}
To updated the trial-level metadata (such as the planting date, design type, description, etc) of one or more existing trials, click the ``Update Existing Trial(s)'' button from the Manage \textgreater{} Field Trials page. This upload can also be used to rename trials or move trials to a different breeding program. In order to update a trial, you must be a curator or a submitter (that is associated with the breeding program of the trials).
\begin{center}\includegraphics[width=0.95\linewidth]{assets/images/update_trial_metadata} \end{center}
Here you can upload a file that contains the new metadata for the existing trials in the database. The first column is labeled `trial\_name' and includes the name of the existing trial. Additional columns can be included for the metadata you want to update. Any columns not included in the file or values left blank will leave the existing metadata unchanged. The columns that can be included are:
\begin{itemize}
\tightlist
\item
new\_trial\_name: A new name for the trial, must not already exist in the database
\item
breeding\_program: The name of breeding program that managed the trial, must exist in the database.
\item
location: The name or abbreviation of the location where the trial was held, must exist in the database.
\item
year: The year the trial was held.
\item
transplanting\_date: The transplanting\_date of the trial was conducted. Date in YYYY-MM-DD format or `remove' to remove the date
\item
planting\_date: Date of Planting in YYYY-MM-DD format or `remove' to remove the date
\item
harvest\_date: Date of Harvest in YYYY-MM-DD format or `remove' to remove the date
\item
design\_type: The shorthand for the design type, must exist in the database. Possible values include CRD: Completely Randomized Design, RCBD: Randomized Complete Block Design, RRC: Resolvable Row-Column, DRRC: Doubly-Resolvable Row-Column, ARC: Augmented Row-Column, Alpha: Alpha Lattice Design, Lattice: Lattice Design, Augmented: Augmented Design, MAD: Modified Augmented Design, greenhouse: undesigned Nursery/Greenhouse, splitplot: Split Plot, p-rep: Partially Replicated, Westcott: Westcott Design
\item
description: Additional text with any other relevant information about the trial.
\item
trial\_type: The name of the trial type, must exist in the database. Possible values include Seedling Nursery, phenotyping\_trial, Advanced Yield Trial, Preliminary Yield Trial, Uniform Yield Trial, Variety Release Trial, Clonal Evaluation, genetic\_gain\_trial, storage\_trial, heterosis\_trial, health\_status\_trial, grafting\_trial, Screen House, Seed Multiplication, crossing\_block\_trial, Specialty Trial
\item
plot\_width: plot width in meters
\item
plot\_length: plot length in meters
\item
field\_size: field size in hectares
\end{itemize}
\hypertarget{deleting-trial-data}{%
\subsection{Deleting Trial Data}\label{deleting-trial-data}}
\section{Deleting Trial Data}\label{deleting-trial-data}}
To delete a trial data, click on the ``Delete trial data'' section. There are links to delete traits, layout and trial entry data.
Expand Down
Binary file added docs/assets/images/update_trial_metadata.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions docs/basic-website-usage.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="Breedbase team" />


<meta name="date" content="2024-07-22" />
<meta name="date" content="2024-12-13" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -185,8 +185,9 @@
<li class="chapter" data-level="10.2.10" data-path="managing-field-trials.html"><a href="managing-field-trials.html#adding-tissue-sample-entries-to-your-trial"><i class="fa fa-check"></i><b>10.2.10</b> Adding Tissue Sample Entries To Your Trial</a></li>
<li class="chapter" data-level="10.2.11" data-path="managing-field-trials.html"><a href="managing-field-trials.html#uploading-gps-coordinates-for-plots"><i class="fa fa-check"></i><b>10.2.11</b> Uploading GPS Coordinates For Plots</a></li>
<li class="chapter" data-level="10.2.12" data-path="managing-field-trials.html"><a href="managing-field-trials.html#uploading-additional-files-to-trial"><i class="fa fa-check"></i><b>10.2.12</b> Uploading Additional Files To Trial</a></li>
<li class="chapter" data-level="10.2.13" data-path="managing-field-trials.html"><a href="managing-field-trials.html#deleting-trial-data"><i class="fa fa-check"></i><b>10.2.13</b> Deleting Trial Data</a></li>
</ul></li>
<li class="chapter" data-level="10.3" data-path="managing-field-trials.html"><a href="managing-field-trials.html#updating-trial-data"><i class="fa fa-check"></i><b>10.3</b> Updating Trial Data</a></li>
<li class="chapter" data-level="10.4" data-path="managing-field-trials.html"><a href="managing-field-trials.html#deleting-trial-data"><i class="fa fa-check"></i><b>10.4</b> Deleting Trial Data</a></li>
</ul></li>
<li class="chapter" data-level="11" data-path="managing-genotyping-plates.html"><a href="managing-genotyping-plates.html"><i class="fa fa-check"></i><b>11</b> Managing Genotyping Plates</a>
<ul>
Expand Down
5 changes: 3 additions & 2 deletions docs/data-analysis-tools.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="Breedbase team" />


<meta name="date" content="2024-07-22" />
<meta name="date" content="2024-12-13" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -185,8 +185,9 @@
<li class="chapter" data-level="10.2.10" data-path="managing-field-trials.html"><a href="managing-field-trials.html#adding-tissue-sample-entries-to-your-trial"><i class="fa fa-check"></i><b>10.2.10</b> Adding Tissue Sample Entries To Your Trial</a></li>
<li class="chapter" data-level="10.2.11" data-path="managing-field-trials.html"><a href="managing-field-trials.html#uploading-gps-coordinates-for-plots"><i class="fa fa-check"></i><b>10.2.11</b> Uploading GPS Coordinates For Plots</a></li>
<li class="chapter" data-level="10.2.12" data-path="managing-field-trials.html"><a href="managing-field-trials.html#uploading-additional-files-to-trial"><i class="fa fa-check"></i><b>10.2.12</b> Uploading Additional Files To Trial</a></li>
<li class="chapter" data-level="10.2.13" data-path="managing-field-trials.html"><a href="managing-field-trials.html#deleting-trial-data"><i class="fa fa-check"></i><b>10.2.13</b> Deleting Trial Data</a></li>
</ul></li>
<li class="chapter" data-level="10.3" data-path="managing-field-trials.html"><a href="managing-field-trials.html#updating-trial-data"><i class="fa fa-check"></i><b>10.3</b> Updating Trial Data</a></li>
<li class="chapter" data-level="10.4" data-path="managing-field-trials.html"><a href="managing-field-trials.html#deleting-trial-data"><i class="fa fa-check"></i><b>10.4</b> Deleting Trial Data</a></li>
</ul></li>
<li class="chapter" data-level="11" data-path="managing-genotyping-plates.html"><a href="managing-genotyping-plates.html"><i class="fa fa-check"></i><b>11</b> Managing Genotyping Plates</a>
<ul>
Expand Down
7 changes: 4 additions & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="Breedbase team" />


<meta name="date" content="2024-07-22" />
<meta name="date" content="2024-12-13" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -185,8 +185,9 @@
<li class="chapter" data-level="10.2.10" data-path="managing-field-trials.html"><a href="managing-field-trials.html#adding-tissue-sample-entries-to-your-trial"><i class="fa fa-check"></i><b>10.2.10</b> Adding Tissue Sample Entries To Your Trial</a></li>
<li class="chapter" data-level="10.2.11" data-path="managing-field-trials.html"><a href="managing-field-trials.html#uploading-gps-coordinates-for-plots"><i class="fa fa-check"></i><b>10.2.11</b> Uploading GPS Coordinates For Plots</a></li>
<li class="chapter" data-level="10.2.12" data-path="managing-field-trials.html"><a href="managing-field-trials.html#uploading-additional-files-to-trial"><i class="fa fa-check"></i><b>10.2.12</b> Uploading Additional Files To Trial</a></li>
<li class="chapter" data-level="10.2.13" data-path="managing-field-trials.html"><a href="managing-field-trials.html#deleting-trial-data"><i class="fa fa-check"></i><b>10.2.13</b> Deleting Trial Data</a></li>
</ul></li>
<li class="chapter" data-level="10.3" data-path="managing-field-trials.html"><a href="managing-field-trials.html#updating-trial-data"><i class="fa fa-check"></i><b>10.3</b> Updating Trial Data</a></li>
<li class="chapter" data-level="10.4" data-path="managing-field-trials.html"><a href="managing-field-trials.html#deleting-trial-data"><i class="fa fa-check"></i><b>10.4</b> Deleting Trial Data</a></li>
</ul></li>
<li class="chapter" data-level="11" data-path="managing-genotyping-plates.html"><a href="managing-genotyping-plates.html"><i class="fa fa-check"></i><b>11</b> Managing Genotyping Plates</a>
<ul>
Expand Down Expand Up @@ -357,7 +358,7 @@ <h1>
<div id="header">
<h1 class="title">User Manual of Breedbase</h1>
<p class="author"><em>Breedbase team</em></p>
<p class="date"><em>2024-07-22</em></p>
<p class="date"><em>2024-12-13</em></p>
</div>
<div id="introduction" class="section level1 unnumbered hasAnchor">
<h1>Introduction<a href="index.html#introduction" class="anchor-section" aria-label="Anchor link to header"></a></h1>
Expand Down
5 changes: 3 additions & 2 deletions docs/managing-accessions.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="Breedbase team" />


<meta name="date" content="2024-07-22" />
<meta name="date" content="2024-12-13" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -185,8 +185,9 @@
<li class="chapter" data-level="10.2.10" data-path="managing-field-trials.html"><a href="managing-field-trials.html#adding-tissue-sample-entries-to-your-trial"><i class="fa fa-check"></i><b>10.2.10</b> Adding Tissue Sample Entries To Your Trial</a></li>
<li class="chapter" data-level="10.2.11" data-path="managing-field-trials.html"><a href="managing-field-trials.html#uploading-gps-coordinates-for-plots"><i class="fa fa-check"></i><b>10.2.11</b> Uploading GPS Coordinates For Plots</a></li>
<li class="chapter" data-level="10.2.12" data-path="managing-field-trials.html"><a href="managing-field-trials.html#uploading-additional-files-to-trial"><i class="fa fa-check"></i><b>10.2.12</b> Uploading Additional Files To Trial</a></li>
<li class="chapter" data-level="10.2.13" data-path="managing-field-trials.html"><a href="managing-field-trials.html#deleting-trial-data"><i class="fa fa-check"></i><b>10.2.13</b> Deleting Trial Data</a></li>
</ul></li>
<li class="chapter" data-level="10.3" data-path="managing-field-trials.html"><a href="managing-field-trials.html#updating-trial-data"><i class="fa fa-check"></i><b>10.3</b> Updating Trial Data</a></li>
<li class="chapter" data-level="10.4" data-path="managing-field-trials.html"><a href="managing-field-trials.html#deleting-trial-data"><i class="fa fa-check"></i><b>10.4</b> Deleting Trial Data</a></li>
</ul></li>
<li class="chapter" data-level="11" data-path="managing-genotyping-plates.html"><a href="managing-genotyping-plates.html"><i class="fa fa-check"></i><b>11</b> Managing Genotyping Plates</a>
<ul>
Expand Down
5 changes: 3 additions & 2 deletions docs/managing-barcodes.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="Breedbase team" />


<meta name="date" content="2024-07-22" />
<meta name="date" content="2024-12-13" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -185,8 +185,9 @@
<li class="chapter" data-level="10.2.10" data-path="managing-field-trials.html"><a href="managing-field-trials.html#adding-tissue-sample-entries-to-your-trial"><i class="fa fa-check"></i><b>10.2.10</b> Adding Tissue Sample Entries To Your Trial</a></li>
<li class="chapter" data-level="10.2.11" data-path="managing-field-trials.html"><a href="managing-field-trials.html#uploading-gps-coordinates-for-plots"><i class="fa fa-check"></i><b>10.2.11</b> Uploading GPS Coordinates For Plots</a></li>
<li class="chapter" data-level="10.2.12" data-path="managing-field-trials.html"><a href="managing-field-trials.html#uploading-additional-files-to-trial"><i class="fa fa-check"></i><b>10.2.12</b> Uploading Additional Files To Trial</a></li>
<li class="chapter" data-level="10.2.13" data-path="managing-field-trials.html"><a href="managing-field-trials.html#deleting-trial-data"><i class="fa fa-check"></i><b>10.2.13</b> Deleting Trial Data</a></li>
</ul></li>
<li class="chapter" data-level="10.3" data-path="managing-field-trials.html"><a href="managing-field-trials.html#updating-trial-data"><i class="fa fa-check"></i><b>10.3</b> Updating Trial Data</a></li>
<li class="chapter" data-level="10.4" data-path="managing-field-trials.html"><a href="managing-field-trials.html#deleting-trial-data"><i class="fa fa-check"></i><b>10.4</b> Deleting Trial Data</a></li>
</ul></li>
<li class="chapter" data-level="11" data-path="managing-genotyping-plates.html"><a href="managing-genotyping-plates.html"><i class="fa fa-check"></i><b>11</b> Managing Genotyping Plates</a>
<ul>
Expand Down
5 changes: 3 additions & 2 deletions docs/managing-breeding-programs.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="Breedbase team" />


<meta name="date" content="2024-07-22" />
<meta name="date" content="2024-12-13" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -185,8 +185,9 @@
<li class="chapter" data-level="10.2.10" data-path="managing-field-trials.html"><a href="managing-field-trials.html#adding-tissue-sample-entries-to-your-trial"><i class="fa fa-check"></i><b>10.2.10</b> Adding Tissue Sample Entries To Your Trial</a></li>
<li class="chapter" data-level="10.2.11" data-path="managing-field-trials.html"><a href="managing-field-trials.html#uploading-gps-coordinates-for-plots"><i class="fa fa-check"></i><b>10.2.11</b> Uploading GPS Coordinates For Plots</a></li>
<li class="chapter" data-level="10.2.12" data-path="managing-field-trials.html"><a href="managing-field-trials.html#uploading-additional-files-to-trial"><i class="fa fa-check"></i><b>10.2.12</b> Uploading Additional Files To Trial</a></li>
<li class="chapter" data-level="10.2.13" data-path="managing-field-trials.html"><a href="managing-field-trials.html#deleting-trial-data"><i class="fa fa-check"></i><b>10.2.13</b> Deleting Trial Data</a></li>
</ul></li>
<li class="chapter" data-level="10.3" data-path="managing-field-trials.html"><a href="managing-field-trials.html#updating-trial-data"><i class="fa fa-check"></i><b>10.3</b> Updating Trial Data</a></li>
<li class="chapter" data-level="10.4" data-path="managing-field-trials.html"><a href="managing-field-trials.html#deleting-trial-data"><i class="fa fa-check"></i><b>10.4</b> Deleting Trial Data</a></li>
</ul></li>
<li class="chapter" data-level="11" data-path="managing-genotyping-plates.html"><a href="managing-genotyping-plates.html"><i class="fa fa-check"></i><b>11</b> Managing Genotyping Plates</a>
<ul>
Expand Down
5 changes: 3 additions & 2 deletions docs/managing-crosses.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="Breedbase team" />


<meta name="date" content="2024-07-22" />
<meta name="date" content="2024-12-13" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -185,8 +185,9 @@
<li class="chapter" data-level="10.2.10" data-path="managing-field-trials.html"><a href="managing-field-trials.html#adding-tissue-sample-entries-to-your-trial"><i class="fa fa-check"></i><b>10.2.10</b> Adding Tissue Sample Entries To Your Trial</a></li>
<li class="chapter" data-level="10.2.11" data-path="managing-field-trials.html"><a href="managing-field-trials.html#uploading-gps-coordinates-for-plots"><i class="fa fa-check"></i><b>10.2.11</b> Uploading GPS Coordinates For Plots</a></li>
<li class="chapter" data-level="10.2.12" data-path="managing-field-trials.html"><a href="managing-field-trials.html#uploading-additional-files-to-trial"><i class="fa fa-check"></i><b>10.2.12</b> Uploading Additional Files To Trial</a></li>
<li class="chapter" data-level="10.2.13" data-path="managing-field-trials.html"><a href="managing-field-trials.html#deleting-trial-data"><i class="fa fa-check"></i><b>10.2.13</b> Deleting Trial Data</a></li>
</ul></li>
<li class="chapter" data-level="10.3" data-path="managing-field-trials.html"><a href="managing-field-trials.html#updating-trial-data"><i class="fa fa-check"></i><b>10.3</b> Updating Trial Data</a></li>
<li class="chapter" data-level="10.4" data-path="managing-field-trials.html"><a href="managing-field-trials.html#deleting-trial-data"><i class="fa fa-check"></i><b>10.4</b> Deleting Trial Data</a></li>
</ul></li>
<li class="chapter" data-level="11" data-path="managing-genotyping-plates.html"><a href="managing-genotyping-plates.html"><i class="fa fa-check"></i><b>11</b> Managing Genotyping Plates</a>
<ul>
Expand Down
Loading

0 comments on commit 8518f7a

Please sign in to comment.