Difference between revisions of "Author Instructions"

From Compendium of Cancer Genome Aberrations
Jump to navigation Jump to search
[checked revision][checked revision]
Line 27: Line 27:
 
*Trainees are highly encouraged and welcome to participate in this effort.  Trainees are asked to work with a mentor to help review their page content before completion.
 
*Trainees are highly encouraged and welcome to participate in this effort.  Trainees are asked to work with a mentor to help review their page content before completion.
 
*For technical issues or any additional questions, please '''[Mailto:CCGA@cancergenomics.org <u>Contact us</u>]'''.  If applicable, please include the title of the page on which the error occurred, a screenshot of the error message, the web browser you were using (i.e. firefox, google chrome, internet explorer, etc) and any other pertinent information.
 
*For technical issues or any additional questions, please '''[Mailto:CCGA@cancergenomics.org <u>Contact us</u>]'''.  If applicable, please include the title of the page on which the error occurred, a screenshot of the error message, the web browser you were using (i.e. firefox, google chrome, internet explorer, etc) and any other pertinent information.
*Of note, the CCGA is a wiki-based platform with the intention that contributors can modify any page at any time if something is not accurate or new evidence and references would be beneficial to share.  This will allow up-to-date accurate content to be available to the community. Primary authorship will typically be listed as those individuals that initially completed the page content and inquiries can be made to to '''[Mailto:CCGA@cancergenomics.org <u>Email</u>]''' if a subsequent user modifies the content and feels the effort put forth is of high enough significance to warrant listing in the authorship section.
+
*Of note, the CCGA is a wiki-based platform with the intention that contributors can modify any page at any time if something is not accurate or new evidence and references would be beneficial to share.  This will allow up-to-date accurate content to be available to the community. Primary authorship will typically be listed as those individuals that initially completed the page content, and inquiries can be made by '''[Mailto:CCGA@cancergenomics.org <u>Email</u>]''' if a subsequent user modifies the content and feels the effort put forth is of high enough significance to warrant listing in the authorship section.
  
 
==Video Tutorial==
 
==Video Tutorial==

Revision as of 18:57, 1 January 2022

Introduction

Thank you for your interest in contributing to this community effort.

  • Please complete the Volunteer Form and the Editor-in-Chief will be happy to discuss your interests and next steps.
  1. Pages in need of authors can be found here: Volunteer Assignments and Opportunities (see “Authors” column and look for any that are not assigned; every attempt is made to keep this updated). 
  2. We will be creating content for all entities with genetic findings in the current WHO Classification of Tumours books, Therefore, if there is an entity not yet listed that you would like to author, we would be happy to create a page for you now.
  • For pages that do not yet have any content, authors will be connected by the Editor-in-Chief with an Associate Editor based on their disease section(s) of interest. 
  • Authors will be given a username and password by the Technical Associate Editor.  
  • Author names will be added to the top of any page(s) that they wish to complete so others know they’re in process.
  • Pages are based on current WHO entries and contain pre-loaded templates (of note, if there’s a non-WHO entity of importance, a new page can be created). Authors are encouraged to work in Word templates, which also have expanded helpful notes and instructions (see section below; please track references by PMIDs as the site allows for automatic input of references based on PMIDs) and then copy/paste the content into the wiki site.
  • There are two types of pages currently needing authors:
  1. Disease category overview pages (for example see Acute Myeloid Leukemia (AML) and Related Precursor Neoplasms), which are summaries of a group of diseases with links to all other relevant content. These will often be completed by Associate Editors but can be authored by others if interested.
  2. Disease-specific pages (for example see any links on the AML page), which is for individual disease entities and much more detailed.
  3. Gene-specific pages (these pages are in the process of being automated for data import and not requiring new authors at this time).
  • For more details on how you use the site to be an author, please watch an instructional video (see section below). Of note, we highly encourage authors to populate all the tables (i.e. for immunophenotype, chromosomal rearrangements, genomic gain/loss/LOH, etc) when applicable.
  • For the timeline, there’s some flexibility and please work with your Associate Editor to set a target date.
  • Once a page is complete, please:
  1. Delete the statement "This page is under construction. We need you help! Please consider joining in the project and submitting a review".
  2. Email the appropriate Associate Editor that the page is complete.
  • Trainees are highly encouraged and welcome to participate in this effort. Trainees are asked to work with a mentor to help review their page content before completion.
  • For technical issues or any additional questions, please Contact us. If applicable, please include the title of the page on which the error occurred, a screenshot of the error message, the web browser you were using (i.e. firefox, google chrome, internet explorer, etc) and any other pertinent information.
  • Of note, the CCGA is a wiki-based platform with the intention that contributors can modify any page at any time if something is not accurate or new evidence and references would be beneficial to share. This will allow up-to-date accurate content to be available to the community. Primary authorship will typically be listed as those individuals that initially completed the page content, and inquiries can be made by Email if a subsequent user modifies the content and feels the effort put forth is of high enough significance to warrant listing in the authorship section.

Video Tutorial

  • A video tutorial on how to author in real-time an overview or disease entity-specific page is available: Video Tutorial. Revised videos for the recently updated templates will be available in the near future.

Word Version Templates

  • Note: Additional helpful information and instructions are provided in these Word templates. If applicable, please do use the provided tables.

Policy for Inclusion of Figures on the CCGA Site

Use of illustrative figures on the Compendium of Cancer Genome Aberrations (CCGA) is encouraged. This policy defines the process for inclusion of a figure.

  1. For figures created by an individual or provided from their lab, the PHI must be removed and the submitter’s name and institution included in the figure legend.
  2. For figures from any other source (such as a website or published paper), a link to the image content, if openly accessible, can be used on the CCGA page.  If such a link is not possible, written permission must be obtained by the person creating the CCGA page before addition to the page.  This written permission should be shared with the Associate Editor of the related section and copied to ccga@cancergenomics.org.  The figure legend should include the appropriate reference and confirmation that permission was obtained.

How to Cite CCGA Pages

  • Citation for a CCGA page on an Author's CV:
  1. Naeini Y, Quintero-Rivera F. “Myeloid Sarcoma”. Compendium of Cancer Genome Aberrations (CCGA), Cancer Genomics Consortium (CGC), created 06/23/2018, https://www.ccga.io/index.php/Myeloid_Sarcoma.
  • Citation in Reports or Other Media:
  1. Naeini Y, Quintero-Rivera F. “Myeloid Sarcoma”. Compendium of Cancer Genome Aberrations (CCGA), Cancer Genomics Consortium (CGC), updated 01/02/2020, https://www.ccga.io/index.php/Myeloid_Sarcoma.