From fcd6175b95d312e8b68a795273b80f40fe2e43de Mon Sep 17 00:00:00 2001 From: Ziv Yaniv Date: Thu, 19 Sep 2024 18:26:37 -0400 Subject: [PATCH] Updating contributor instructions. Add information on including images supporting reagent validation claims. --- docs_in/contrib.md.in | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs_in/contrib.md.in b/docs_in/contrib.md.in index d3f48de..fecb00f 100644 --- a/docs_in/contrib.md.in +++ b/docs_in/contrib.md.in @@ -57,7 +57,11 @@ Do not use non-ASCII characters such as ™ or α (either remove or rep 1. Add a line to the [reagent_resources.csv](https://github.com/IBEXImagingCommunity/ibex_imaging_knowledge_base/blob/main/data/reagent_resources.csv). 2. Create corresponding supporting material sub-directory using the target_conjugate as the directory name and add a markdown file with your ORCID as the file prefix (see existing files for reference). Supporting material file has a fixed layout, see [supporting_template.md](supporting_template.md). **Note**: When creating the target_conjugate sub-directory you will need to replace the following characters with an underscore: space, tab, "/", "\", "{", "}", "[", "]", "(", ")", "<", ">", ":", "&". Consequently, supporting material for the target conjugate pair of "Chicken IgY (H&L)", "FITC" is found in a directory named "Chicken_IgY__H_L__FITC". -3. Optionally add *small* (<300KB) image files (jpg) and refer to them in the supporting material file. Please format your images as 72dpi, 24bit color, 1200x1200px. Write caption identifying validated reagent. Use colorblind safe colors (e.g. cyan, red; magenta, green, blue; no green and red). Include scale bar. Use zoom that allows fine details to be seen. See an example [here](./supporting_material/CD21_PE/0000-0003-4379-8967.md). +3. Optionally add *small* (<300KB) image files (jpg) and refer to them in the supporting material file. Please format your images as 72dpi, 24bit color, 1200x1200px. Write caption identifying validated reagent. Use colorblind safe colors (e.g. cyan, red; magenta, green, blue; no green and red). Include scale bar. Use zoom that allows fine details to be seen. See an example [here](./supporting_material/CD21_PE/0000-0003-4379-8967.md). Add the file information to the `image_resources.csv` file found in the data directory. +For general information about image quality and content for use in supporting scientific claims see: + * "Community-developed checklists for publishing images and image analyses", C. Schmied et al., Nat. Methods, 2024, doi: [10.1038/s41592-023-01987-9](https://doi.org/10.1038/s41592-023-01987-9). + * [Figure Making Best Practices video](https://www.youtube.com/watch?v=CgfnlcxbjuI), 2024, on the [BioImaging North America (BINA) YouTube channel](https://www.youtube.com/@BioImagingNorthAmerica). + * "Creating clear and informative image-based figures for scientific publications", H. Jambor et al., PLOS Biology, 2021, doi: [10.1371/journal.pbio.3001161](https://doi.org/10.1371/journal.pbio.3001161) #### Adding information to existing line: