Don't Make Me Read: Tips for Writing Effective Documentation
At the Data Lab, we invest to ensure that our tools are valuable and functional for our community. Documentation is a key part of ensuring that our tools are easy to use.
Over the past year, we conducted several usability evaluations for two of our data pipelines: ScPCA-nf and ScPCA Downstream Analysis.
- ScPCA-nf is a Nextflow workflow (scpca-nf) that is used to process 10x single-cell data as part of the Single-cell Pediatric Cancer Atlas (ScPCA) portal. The workflow processes fastq files from single-cell and single-nuclei RNA-seq samples using alevin-fry to create gene-by-cell matrices as SingleCellExperiment objects.
- ScPCA Downstream Analysis hosts a set of Snakemake workflows designed to work on the data available on the ScPCA Portal or the output of the scpca-nf pipeline. Among its workflows, it contains a core workflow that performs initial pre-processing of gene expression data, as well as separate workflows for performing Clustering Analysis and Genes of Interest Analysis.
We learned several lessons on writing helpful documentation through observations and feedback from users.
Our usability studies have taught us that the technical and text-heavy nature of documentation often makes it challenging for users to effectively absorb what they are reading and use it. Our goal is to structure and format the dense content to make it easier for users to find information. The documentation for ScPCA-nf and ScPCA Downstream Analysis are written as a set of linked markdown files. This blog post will focus on techniques to structure and format dense walls of text for better readability, using the documentation for our data pipelines as examples.
Structuring Content
A well-structured documentation facilitates discovery, providing the right information at the right time. These are the questions users want to answer when they interact with documentation.
- What is this tool and is it for me?
- How can I use it?
- What are these configurations? How can I change them?
Layering Documentation
Layering documentation is a lot like painting. An artist starts out with big splashes of color, with rough and broad strokes. Next, they add lines giving shape and structure to various elements in the painting, and finally, they add the little details like texture, shading, and smoothing out the rough edges.
Similarly, for documentation to be effective, readers need to be eased into the technical details; otherwise they will leave confused and disoriented. Provide information starting with high-level descriptions, and then build upon their basic understanding to get into the finer details of the tool.
Let’s examine what that might look like using an example from our ScPCA-nf and ScPCA Downstream Analysis documentation.
Big Broad Strokes
The first layers should focus on answering questions about what the tool is and should provide just enough information so users can decide whether it is for them or not.
This includes:
- Introducing the tool - Tell the readers what it does, what outputs to expect, and any other basic context that would be helpful.
For example, ScPCA Downstream Analysis is designed to work with data from the ScPCA portal. This is helpful context to provide to both users who want to use the pipeline as is and to those who might want to modify it for their own purposes.
- Outlining the steps to install and run the tool - Give an idea of what it takes to use the tool and how much effort is needed.
Adding Structure
The next layer should focus on helping users set up and use the tool, providing a structured way to approach utilizing the tool.
This includes:
Hardware and software requirements to run the tool.
A how-to guide - At this level, we can add a little more detail about what is required at each step and link users to detailed instructions for each step. Depending on the tool, some of the steps can be:
- How to organize the files
- What types of input files to provide
- What configurations are required
This information is also helping users to answer the question “Is it for me?” and “How much effort will it take to use the tool?” In addition, this granularity of information is useful to returning power users who may need to refresh their memory but don’t want to wade through all of the instructions again.
The example below shows the Overview section of installation instructions for ScPCA-nf. The overview lays out all the steps required to successfully run the pipeline, providing links to more documentation at each step.
Take a look at the full overview section here!
The Fine Details
The final layer is where you get into the nitty gritty technical details of the tool.
This includes:
- Detailed instructions for setting up - details of input parameters, configuration files and their structure. In ScPCA-nf, we link each step of the overview to detailed instructions like information about each of the columns in the Metadata config file.
- Advanced options for customizing the tool and when to use them. In the ScPCA Downstream Analysis pipeline, we link users to Additional Workflow Parameters after we have walked them through setting up the basic parameters.
Power of a Good Example
Most users in our study mentioned how useful a working example is when working with a new tool. Provide example input data, configuration files, and output data so users have something tangible to fiddle with and get a better understanding of the tool.
There are several advantages to providing examples.
- You can refer to examples in your documentation to make your instructions/descriptions more effective.
- An example reduces the investment required from the user to try the tool and get a deeper understanding of what to expect.
- A working example instills user’s confidence in your tool.
In ScPCA-nf, we provide an example directory that contains
- Example configuration files: Users don’t need to create their own configuration files referencing the documentation. This reduces the frustrating errors they might encounter due to minute mistakes in setting up their own configuration files.
- Example input data and how to use it: Users can try to use the pipeline on their own without needing to bring their own data.
- Example output files: Users have something tangible to explore without investing too much time and effort.
Presenting Content
When it comes to writing effective documentation, how you say it matters just as much as what you say. Even a well-structured document can be hard to comprehend if the language and formatting are arduous.
Language
Keep it simple.
- Write the documentation in a simple language and only use as many domain-specific terms as needed.
- Passive voice makes it difficult to comprehend the sentences. Adopt an active voice and keep the sentences as short as possible.
- Use a causal tone, don’t hesitate to use second-person pronouns like “We” or “you”. It makes the docs feel friendly and welcoming.
Formatting
People don’t read, they scan.
People scan in an ‘F’ pattern on text-heavy websites, which means that they usually end up reading only the first few words of every line.
Formatting for Scanning:
- Use informative headings: Informative headings make it easier for readers to get the most out of scanning.
- Write smaller sentences and paragraphs. They are easier to comprehend.
- Break up paragraphs into bulleted lists wherever possible to make information easier to consume.
- Draw the user’s attention to important items like crucial steps, links to valuable information, and examples. For example, you can distinguish the important links with this markdown button hack.
- Use tables to describe long lists of parameters.
Effective language and formatting in action!
Let’s look at this before and after from one section of our ScPCA Downstream analysis documentation.
On the left, the before version does a few things well. It uses formatting, and the heading is informative. It uses a table to draw attention to the fields that are required to be changed, which is an important step. However, there is still room for improvement. The information is difficult to scan since there is a big chunk of dense text. The language is informational, but it isn’t explicitly clear what actions the reader is expected to take.
On the right, we have the improved version. The information is broken down into bullets where possible. The sentences are more concise, and it provides clear instructions as to what readers can do with the information. It is easier to scan.
Let’s face it…
Writing effective documentation is challenging. Users might not always read every word in the documentation. They might even just scroll past large chunks of text, but we can accommodate those behaviors.
Give these key tips a try when writing documentation for your tools!
- Structure your documentation to start with high-level information and ease into lower-level details.
- Provide sufficient examples.
- Use simple language and short sentences as much as possible.
- Leverage the ‘F pattern’ and use clever text formatting to guide the reader’s attention to important information.
Interested in reading about other ways we prioritize the needs of our users when designing Data Lab tools? Check out this blog post to learn more about our user research activities!
At the Data Lab, we invest to ensure that our tools are valuable and functional for our community. Documentation is a key part of ensuring that our tools are easy to use.
Over the past year, we conducted several usability evaluations for two of our data pipelines: ScPCA-nf and ScPCA Downstream Analysis.
- ScPCA-nf is a Nextflow workflow (scpca-nf) that is used to process 10x single-cell data as part of the Single-cell Pediatric Cancer Atlas (ScPCA) portal. The workflow processes fastq files from single-cell and single-nuclei RNA-seq samples using alevin-fry to create gene-by-cell matrices as SingleCellExperiment objects.
- ScPCA Downstream Analysis hosts a set of Snakemake workflows designed to work on the data available on the ScPCA Portal or the output of the scpca-nf pipeline. Among its workflows, it contains a core workflow that performs initial pre-processing of gene expression data, as well as separate workflows for performing Clustering Analysis and Genes of Interest Analysis.
We learned several lessons on writing helpful documentation through observations and feedback from users.
Our usability studies have taught us that the technical and text-heavy nature of documentation often makes it challenging for users to effectively absorb what they are reading and use it. Our goal is to structure and format the dense content to make it easier for users to find information. The documentation for ScPCA-nf and ScPCA Downstream Analysis are written as a set of linked markdown files. This blog post will focus on techniques to structure and format dense walls of text for better readability, using the documentation for our data pipelines as examples.
Structuring Content
A well-structured documentation facilitates discovery, providing the right information at the right time. These are the questions users want to answer when they interact with documentation.
- What is this tool and is it for me?
- How can I use it?
- What are these configurations? How can I change them?
Layering Documentation
Layering documentation is a lot like painting. An artist starts out with big splashes of color, with rough and broad strokes. Next, they add lines giving shape and structure to various elements in the painting, and finally, they add the little details like texture, shading, and smoothing out the rough edges.
Similarly, for documentation to be effective, readers need to be eased into the technical details; otherwise they will leave confused and disoriented. Provide information starting with high-level descriptions, and then build upon their basic understanding to get into the finer details of the tool.
Let’s examine what that might look like using an example from our ScPCA-nf and ScPCA Downstream Analysis documentation.
Big Broad Strokes
The first layers should focus on answering questions about what the tool is and should provide just enough information so users can decide whether it is for them or not.
This includes:
- Introducing the tool - Tell the readers what it does, what outputs to expect, and any other basic context that would be helpful.
For example, ScPCA Downstream Analysis is designed to work with data from the ScPCA portal. This is helpful context to provide to both users who want to use the pipeline as is and to those who might want to modify it for their own purposes.
- Outlining the steps to install and run the tool - Give an idea of what it takes to use the tool and how much effort is needed.
Adding Structure
The next layer should focus on helping users set up and use the tool, providing a structured way to approach utilizing the tool.
This includes:
Hardware and software requirements to run the tool.
A how-to guide - At this level, we can add a little more detail about what is required at each step and link users to detailed instructions for each step. Depending on the tool, some of the steps can be:
- How to organize the files
- What types of input files to provide
- What configurations are required
This information is also helping users to answer the question “Is it for me?” and “How much effort will it take to use the tool?” In addition, this granularity of information is useful to returning power users who may need to refresh their memory but don’t want to wade through all of the instructions again.
The example below shows the Overview section of installation instructions for ScPCA-nf. The overview lays out all the steps required to successfully run the pipeline, providing links to more documentation at each step.
Take a look at the full overview section here!
The Fine Details
The final layer is where you get into the nitty gritty technical details of the tool.
This includes:
- Detailed instructions for setting up - details of input parameters, configuration files and their structure. In ScPCA-nf, we link each step of the overview to detailed instructions like information about each of the columns in the Metadata config file.
- Advanced options for customizing the tool and when to use them. In the ScPCA Downstream Analysis pipeline, we link users to Additional Workflow Parameters after we have walked them through setting up the basic parameters.
Power of a Good Example
Most users in our study mentioned how useful a working example is when working with a new tool. Provide example input data, configuration files, and output data so users have something tangible to fiddle with and get a better understanding of the tool.
There are several advantages to providing examples.
- You can refer to examples in your documentation to make your instructions/descriptions more effective.
- An example reduces the investment required from the user to try the tool and get a deeper understanding of what to expect.
- A working example instills user’s confidence in your tool.
In ScPCA-nf, we provide an example directory that contains
- Example configuration files: Users don’t need to create their own configuration files referencing the documentation. This reduces the frustrating errors they might encounter due to minute mistakes in setting up their own configuration files.
- Example input data and how to use it: Users can try to use the pipeline on their own without needing to bring their own data.
- Example output files: Users have something tangible to explore without investing too much time and effort.
Presenting Content
When it comes to writing effective documentation, how you say it matters just as much as what you say. Even a well-structured document can be hard to comprehend if the language and formatting are arduous.
Language
Keep it simple.
- Write the documentation in a simple language and only use as many domain-specific terms as needed.
- Passive voice makes it difficult to comprehend the sentences. Adopt an active voice and keep the sentences as short as possible.
- Use a causal tone, don’t hesitate to use second-person pronouns like “We” or “you”. It makes the docs feel friendly and welcoming.
Formatting
People don’t read, they scan.
People scan in an ‘F’ pattern on text-heavy websites, which means that they usually end up reading only the first few words of every line.
Formatting for Scanning:
- Use informative headings: Informative headings make it easier for readers to get the most out of scanning.
- Write smaller sentences and paragraphs. They are easier to comprehend.
- Break up paragraphs into bulleted lists wherever possible to make information easier to consume.
- Draw the user’s attention to important items like crucial steps, links to valuable information, and examples. For example, you can distinguish the important links with this markdown button hack.
- Use tables to describe long lists of parameters.
Effective language and formatting in action!
Let’s look at this before and after from one section of our ScPCA Downstream analysis documentation.
On the left, the before version does a few things well. It uses formatting, and the heading is informative. It uses a table to draw attention to the fields that are required to be changed, which is an important step. However, there is still room for improvement. The information is difficult to scan since there is a big chunk of dense text. The language is informational, but it isn’t explicitly clear what actions the reader is expected to take.
On the right, we have the improved version. The information is broken down into bullets where possible. The sentences are more concise, and it provides clear instructions as to what readers can do with the information. It is easier to scan.
Let’s face it…
Writing effective documentation is challenging. Users might not always read every word in the documentation. They might even just scroll past large chunks of text, but we can accommodate those behaviors.
Give these key tips a try when writing documentation for your tools!
- Structure your documentation to start with high-level information and ease into lower-level details.
- Provide sufficient examples.
- Use simple language and short sentences as much as possible.
- Leverage the ‘F pattern’ and use clever text formatting to guide the reader’s attention to important information.
Interested in reading about other ways we prioritize the needs of our users when designing Data Lab tools? Check out this blog post to learn more about our user research activities!
Related Post
In March 2022, we launched the Single-cell Pediatric Cancer Atlas (ScPCA) Portal to make uniformly processed single-cell and single-nuclei RNA-Seq data widely available to the childhood cancer research community. Initially, all data available on the Portal was generated through grants funded by Alex’s Lemonade Stand Foundation (ALSF) as part of the ScPCA project. But enabling access to ALSF-funded data was just the beginning of our vision.Sharing is key to ensuring the Portal’s continued growth. Our sights were set on allowing more pediatric cancer researchers to contribute data to the ScPCA Portal.
The Data Lab has just launched the brand new Open Single-cell Pediatric Cancer Atlas (OpenScPCA) project! This open, collaborative project aims to analyze data from the ScPCA Portal, which currently holds 500 samples from over 50 pediatric cancer types. We are seeking contributors with diverse skills and expertise to join the project!
We are excited to announce that our next virtual workshop, Introduction to Single-cell RNA-Seq, will run from June 10-14, 2024! In this workshop, Data Lab staff will introduce researchers studying pediatric cancer to the R programming language, the Tidyverse R packages for data science, single-cell RNA-seq data analysis, and annotating cell types.
Applications are open for the Data Lab's next workshop! We are holding a two-day course on Reproducible Research Practices and the Open Single-cell Pediatric Cancer Atlas (OpenScPCA) project from May 14-15, 2024. Please note that the OpenScPCA module is an optional part of the workshop. The course begins with an introduction to principles and techniques to achieve reproducible results in computational cancer research. On day two, you can choose to continue the workshop and learn how to put your skills to use for OpenScPCA, our new pediatric cancer research project.
Are you attending the American Association for Cancer Research (AACR) annual meeting in San Diego, CA? Visit the Alex’s Lemonade Stand Foundation (ALSF) Grants and Data Lab teams at booth 3755 in the exhibit hall from April 7-10 and during poster sessions on April 8. We will announce a new collaborative project and share exciting news about the Single-cell Pediatric Cancer Atlas Portal and training opportunities!
Did you know that 70% of the Alex’s Lemonade Stand Foundation (ALSF) Childhood Cancer Data Lab team are currently women? Advancing our mission to empower childhood cancer researchers with knowledge, data, and tools would not be possible without their expertise. On the International Day of Women and Girls in Science, we are excited to introduce you to these women who integrate science, engineering, and design to tackle some of the greatest challenges faced by the pediatric cancer research community!
I have a confession to make: I am lazy. Ok, maybe that's too strong. Let's go for a euphemism instead: I am efficient. I love learning handy tricks that make my life easier and make my job smoother with fewer hiccups along the way. This is one part of why, here in the Data Lab, we love automation - why waste our time on rote, repetitive, housekeeping tasks when we can get the bots to do it for us? In this blog post, we'll highlight a few tips about how you can use RStudio to code more efficiently.
Writing source code is a significant part of data-intensive biomedical research. Everything from cleaning and pre-processing data to generating publication figures can be accomplished programmatically. Increasingly, funding agencies and journals require researchers to share their code. To pick a few examples, the Data Lab’s parent organization, Alex’s Lemonade Stand Foundation (ALSF), has such a requirement for awardees, and PLoS Computational Biology requires authors to make code underlying results and conclusions available.
There is an old joke in computer science about how there are only two hard things: cache invalidation, naming things, and off-by-one errors. I’ll leave aside the first one as beyond my own expertise, but the second comes up all the time in my work as a biological data scientist. Naming variables and functions in my code is a constant struggle, but one I have to deal with on my own or with my team. Much bigger problems come up when trying to deal with all the various ways that people across the world use names when talking about the diseases they work on, the types of cells they are looking at, the experimental methods they are using, and just about every other aspect of their studies.
Applications are open for the Data Lab's next workshop! We will be holding a Reproducible Research Practices Course in-person on October 24-25, 2023. Instructors will introduce principles and techniques to achieve reproducible results in computational cancer research. We’ll show you the fundamentals of commonly-used approaches in reproducibility that you can apply to increase the impact of your research by making your findings more robust and reliable! To ensure that workshop attendees have a great hands-on experience, there will be a very limited number of seats available.
At the Center for Data-Driven Discovery in Biomedicine (D3b), I lead the Bioinformatics Translational Pediatric Oncology Team, a team of bioinformatics scientists. Our mission is to advance pediatric oncology research and precision medicine through collaboration and development of open-source analytical tools, frameworks, and data resources. In 1998, I lost my four year old cousin John Matthew to a brain tumor we now know was likely a diffuse intrinsic pontine glioma. So, it was bittersweet for me to see the Open Pediatric Brain Tumor Atlas (OpenPBTA) manuscript published in Cell Genomics on the last day of brain tumor awareness month this past year. But let’s rewind.
In 2019, Alex’s Lemonade Stand Foundation (ALSF) established the Single-cell Pediatric Cancer Atlas (ScPCA) through awards for data generation and to create an atlas of single-cell gene expression profiles of pediatric cancers of different types and from different organ sites. The Data Lab launched the ScPCA Portal in 2022 to make uniformly processed, summarized single-cell and single-nuclei RNA-seq data and de-identified metadata available for download. The ScPCA Portal also supports other data modalities, such as bulk RNA-seq, CITE-seq, and spatial transcriptomics. The ScPCA Portal currently hosts data for over 500 pediatric tumor and patient-derived xenograft samples from more than 50 cancer types, and continues to grow. The Data Lab is seeking contributions to the ScPCA Portal from researchers with existing single-cell datasets.
We are excited to announce that our next workshop, Introduction to Single-cell RNA-Seq, will take place in-person from June 13-15, 2023! Data Lab staff will introduce researchers studying pediatric cancer to the R programming language, the Tidyverse R packages for data science, single-cell RNA-seq data analysis, annotating cell types, and more. The 3-day course will take place from 9am-5pm Eastern time in Bala Cynwyd, PA, just outside of Philadelphia. Travel reimbursement (up to a certain amount) is available for qualifying participants.
The Childhood Cancer Data Lab maintains a collection of uniformly processed single-cell data from pediatric cancer clinical samples and xenografts in the Single-cell Pediatric Cancer Atlas (ScPCA) Portal. Although access to preprocessed data saves researchers time, we know that the downloads from the ScPCA Portal are only the starting point. That’s why we’ve created downstream analysis workflows for commonly performed analyses. Instead of writing code wholesale, you can analyze data once you’ve configured these workflows.
We are excited to announce that our next virtual workshop, Introduction to Single-cell RNA-Seq, will run from May 15-19, 2023! In this workshop, Data Lab staff will introduce researchers studying pediatric cancer to the R programming language, the Tidyverse R packages for data science, single-cell RNA-seq data analysis, and annotating cell types.
Last year, the Data Lab launched the Single-cell Pediatric Cancer Atlas (ScPCA) Portal, which today holds uniformly processed single-cell gene expression data obtained from 8 separate labs, over 480 samples, and representing 38 cancer types. The portal is still growing as we continue to receive and process raw data from ScPCA investigators! All uniformly processed data is made available for download on the ScPCA Portal, giving researchers easy access to a growing database of summarized gene expression data and metadata to utilize for their own research. But how exactly did we make sure that all of the data was uniformly processed? And how are we able to ensure uniform processing for incoming samples as the portal continues to grow?
Are you attending the American Association for Cancer Research (AACR) annual meeting in Orlando, FL this year? Visit Alex's Lemonade Stand Foundation (ALSF) at booth 369 in the exhibit hall from April 16-19! You'll find information about ALSF's grants program, the Childhood Cancer Data Lab and more. The Data Lab will also be holding office hours during select time slots.
The Data Lab is excited to announce that our next training workshop will be held virtually from March 13-17, 2023! During this workshop, we will cover advanced topics in the analysis of single-cell RNA-seq data for researchers studying pediatric cancer. The workshop will take place each day from 12-5pm Eastern. Each day consists of lectures and designated time for attendees to work on exercise materials and their own projects with our staff available for consultation. You’ll need a laptop with internet access and to install Zoom and Slack. You will log into an RStudio Server hosted by the Data Lab from your web browser. Pediatric cancer researchers are encouraged to apply now!
In September 2022, the Open Pediatric Brain Tumor Atlas (OpenPBTA) project culminated (for now) in a preprint on bioRxiv. This project, started in late 2019 and co-organized with the Center for Data Driven Discovery in Biomedicine (D3b) at Children’s Hospital of Philadelphia (CHOP), is a collaborative effort to comprehensively describe the Pediatric Brain Tumor Atlas (PBTA), a collection of multiple data types from tens of tumor types (read more about why crowdsourcing expertise for the study of pediatric brain tumors is important here). The project is designed to allow for contributions from experts across multiple institutions. We’ve conducted analysis and drafting of the manuscript openly on the version-control platform GitHub from the project’s inception to facilitate those contributions.
Recently, we told you about the Single-cell Pediatric Cancer Atlas (ScPCA) downstream analysis workflow. This ready-to-go workflow is intended to be used with single-cell and single-nuclei gene expression data available on the ScPCA Portal. We developed this workflow to filter, normalize, and perform dimensionality reduction, as well as incorporate initial clustering results to each processed sample/library object. Now we’re excited to introduce one of our latest offerings for use with ScPCA data, a clustering analysis workflow, which can be applied to datasets after running the filtering, normalization, and dimensionality reduction workflow!
The Data Lab is excited to announce that our next training workshop will be held in-person from January 31-February 2, 2023! During this workshop, we will cover advanced topics in the analysis of single-cell RNA-seq data for researchers studying pediatric cancer. The 3-day course will take place from 9am-5pm Eastern time in Bala Cynwyd, PA, just outside of Philadelphia. Travel reimbursement is available for qualifying participants.
Welcome to the Data Lab’s December Scientific Community Bulletin! Each month we share upcoming opportunities from Alex’s Lemonade Stand Foundation (ALSF), the Data Lab, and other events that we have gathered from a variety of science and research organizations. Subscribe to our blog to be alerted about future Scientific Community Bulletin posts!
In this blog post, I’d like to give an overview of the refine.bio refactoring process and web accessibility considerations. Through this process, our goal is to enhance the site usability and performance by improving the code quality and making the application more accessible. But before going into more details about them, let me provide you a quick history of refine.bio.
Welcome to the Data Lab’s November Scientific Community Bulletin! Each month we share upcoming opportunities from Alex’s Lemonade Stand Foundation (ALSF), the Data Lab, and other events that we have gathered from a variety of science and research organizations. Subscribe to our blog to be alerted about future Scientific Community Bulletin posts!
Here at the Data Lab, we're all about, well, data! We believe that data sharing and accessibility is key to accelerating the research process, and ultimately to improving outcomes for childhood cancer patients. So, we were excited to learn that one of the goals of the NCI/NIH initiative, the Childhood Cancer Data Initiative (CCDI), is to build up a Data Ecosystem that will facilitate pediatric cancer researchers' ability to explore and collect data from disparate resources. Although this Ecosystem is still in the early stages, several components are already being developed and are available for researchers to use! One component that is particularly interesting to us is the CCDI's Childhood Cancer Data Catalog (CCDC).
Welcome to the October Scientific Community Bulletin! Each month we share upcoming opportunities from Alex’s Lemonade Stand Foundation (ALSF), the Data Lab, and other events that we have gathered from a variety of science and research organizations. Subscribe to our blog to be alerted about future Scientific Community Bulletin posts!
Welcome to the September Scientific Community Bulletin! Each month we share upcoming opportunities from Alex’s Lemonade Stand Foundation (ALSF), the Data Lab, and other events that we have gathered from a variety of science and research organizations. Subscribe to our blog to be alerted about future Scientific Community Bulletin posts!
At the Data Lab, we are constantly looking for ways to enhance the tools we build for pediatric cancer researchers. Earlier this year, we launched the Single-cell Pediatric Cancer Atlas portal, a database of uniformly-processed single-cell data from pediatric cancer clinical samples. One way we felt the portal could be even more beneficial to pediatric cancer researchers is with a ready-to-go workflow that takes in single-cell data and prepares it for downstream analyses such as unsupervised clustering.
The Data Lab is excited to announce our next virtual workshop running from September 19-23, 2022! In this workshop, Data Lab staff will introduce researchers studying pediatric cancer to the R programming language, the Tidyverse R packages for data science, single-cell RNA-seq data analysis, and pathway analysis.
The Data Lab teaches data science courses targeted toward pediatric cancer researchers that introduce topics such as analysis of gene expression in bulk and single-cell data and principles of reproducible research. I wrote previously about how we use RStudio Server for our remote courses to simplify setup, and I wanted to write a bit more about some of the instructional practices we use so that our participants get the best experience we can provide. In particular, I wanted to talk about our use of live coding to facilitate active learning, and one of the tools we developed to make our course development just a bit easier.
Welcome to the August Scientific Community Bulletin! Each month we share upcoming opportunities from Alex’s Lemonade Stand Foundation (ALSF), the Data Lab, and other events that we have gathered from a variety of science and research organizations.
Often when building a server-client web application, we will encounter a situation where we want to send requests to our API in the chronological order that they occur on the client. Due to the asynchronous nature of these requests, it might not be possible to send them in the same callback for the event that triggered them. This is because we want to use the response from the previous request to craft our current one. A solution to this problem would be to implement a queue. Instead of calling the API immediately after events occur, implementing a queue ensures the latest data is sent with any request.
Welcome to the July Scientific Community Bulletin! Each month we share upcoming opportunities from Alex’s Lemonade Stand Foundation (ALSF), the Data Lab, and other events that we have gathered from a variety of science and research organizations. Subscribe to our blog to be alerted about future Scientific Community Bulletin posts!
Welcome to the Childhood Cancer Data Lab’s new blog feature, the monthly Scientific Community Bulletin! At the start of each month, we will share upcoming opportunities from Alex’s Lemonade Stand Foundation (ALSF), the Data Lab, and other events that we have gathered from a variety of science and research organizations. Our goal is to promote learning opportunities and highlight some of the excellent resources that our community provides.
At the Data Lab, our science team has a practice where an individual team member shares something that they recently figured out (or didn’t totally figure out yet) on a biweekly basis. We call this short 5-10 minute presentation How I Solved This, and it’s a great way to formally share (often hard-won) knowledge with each other. In this post, we thought we’d share how we solved something with the `renv` package with you.
The Childhood Cancer Data Lab builds resources guided by the most pressing needs of our primary users: pediatric cancer researchers. As the Data Lab's UX Designer, I conduct research activities with scientists like usability evaluations, semi-structured interviews, and card sorts to gain insight into their activities, processes, pain-points, and behaviors. I work with scientists and engineers at the Data Lab to use this information to improve existing products and services or to create new ones.
The Data Lab is excited to announce that our next training workshop is taking place in-person on Friday, June 10, 2022! During this full day workshop, instructors will introduce principles and techniques to achieve reproducible results in computational cancer research. We’ll show you the fundamentals of commonly-used approaches in reproducibility that you can apply to increase the impact of your research by making your findings more robust and reliable!
The Childhood Cancer Data Lab is growing as a resource for pediatric cancer researchers and we have more to offer to our community now, than ever before. Transitioning to our new and improved website is an exciting milestone, and here, we look forward to sharing progress, introducing new initiatives, and cultivating more opportunities to support childhood cancer research. Welcome to our new virtual home!
The Single-cell Pediatric Cancer Atlas (ScPCA) project began in 2019 when Alex’s Lemonade Stand Foundation (ALSF) funded 10 awards for single-cell profiling of pediatric cancer samples. The goal was to produce an atlas of gene expression profiles for a variety of childhood cancer types from different organ sites.
The CCDL team includes science, engineering, and design expertise. Combining these three disciplines in different ways across projects enables us to carry out our mission.
Here at the CCDL we value putting publicly available data to work. For example, we are currently processing and normalizing 1.5 million publicly available gene expression samples totaling ~$1.5 billion research dollars expended.
Like many teams that work with large amounts of external software, we run into issues with our transitive dependencies. In general, transitive dependencies are a hard problem to solve.
Though technology can introduce great benefit into our lives, it is often accompanied by a substantial amount of time and some expected frustration before we can reap the rewards. The time spent learning a new technology is what we usually call a learning curve.
The workshop will last from 9AM to 5PM on October 14th, 15th, and 16th at the CCDL offices at 1429 Walnut St Philadelphia, PA, 19102.
MultiPLIER is a machine learning approach that brings big data to bear on rare diseases. It’s also an example of the scientific approach and ethos of the CCDL, and the publication is a great opportunity to share how the CCDL is developing new technologies to accelerate research into cures for childhood cancers!
The Childhood Cancer Data Lab powered by Alex's Lemonade Stand Foundation is hosting a workshop to introduce childhood cancer researchers to reproducible analysis of bulk and single-cell transcriptomic data.
The Childhood Cancer Data Lab (CCDL), an initiative of Alex's Lemonade Stand Foundation develops tools, trainings, and methods to empower childhood cancer researchers. The work at the CCDL is focused and impactful. There are multiple opportunities and challenges for you to apply and grow your skills as a scientist or as an engineer.
The Childhood Cancer Data Lab powered by Alex's Lemonade Stand Foundation is hosting a workshop to introduce childhood cancer researchers to reproducible analysis of bulk and single-cell transcriptomic data.
At this hands-on, 3-day session held in Houston, researchers learned data science skills that could accelerate their own work. Drawing on skills learned at the workshop, childhood cancer researchers can perform basic analyses of their work to make informed decisions on how to proceed with their own research. Don’t just take our word for it, though. Read more about the workshop’s incredibly valuable benefits through its attendees’ perspectives.
The goal of our refine.bio project is to download, process, and make available gene expression datasets that can be analyzed together, or in parts, depending on a researcher’s need. Childhood cancer researchers need to be able to use data generated through multiple profiling technologies including microarrays and RNA-sequencing.
There are countless log blog posts out there about the benefits of good logging, how to log well, and how much to log. Going through them all can be a real log blog slog. Wouldn't it be cool if you could log like this:logger.info("Something happened!", job=job.id, user=user.id) and get an easily searchable output.
Caffeine is a stimulant that can induce alertness in certain individuals when consumed at an appropriate quantity. Caffeine is often obtained by ingesting caffeine-containing solutions. However, no protocol for obtaining caffeine from dehydrated, roasted beans using materials typically available in a Philadelphia office has been described in the published literature.
Alex’s Lemonade Stand Foundation (ALSF) staunchly believes that stronger scientific sharing practices will accelerate the pace of discovery and finding cures for children with cancer. Robust sharing improves reproducibility, minimizes redundant studies and maximizes our return on research investment.
Earlier this year, Alex’s Lemonade Stand Foundation identified single-cell gene expression profiling as an opportunity to build an atlas of cell types within tumors that could be broadly reused by pediatric cancer researchers.
This year was a big one for the CCDL. In our mission to empower pediatric cancer experts poised for big discoveries with the knowledge, data and methods to reach them we launched a software product, developed and delivered training workshops on single-cell and bulk RNA-seq analysis, and hired our data science team among other milestones.
I’m a scientist at Sage Bionetworks, a nonprofit research organization in Seattle, WA. My work focuses on a family of rare pediatric diseases (NF): neurofibromatosis type 1, type 2, and schwannomatosis.
Our particular process is designed to source opportunities from our team members and external stakeholders, convert those opportunities into a set of potential goals, and then select the goals that we expect will most advance our mission.
The ability to restore scroll position is often critical for website usability. It helps users keep the flow of navigation when going back and forth between different pages. Most modern browsers take care of restoring the scroll position automatically, but it doesn’t always work for Single Page Applications where the content is generated on the client’s side, often asynchronously.
Carnegie Mellon University Libraries is partnering with the Childhood Cancer Data Lab (CCDL), founded by Alex’s Lemonade Stand Foundation, to host a Data Analysis workshop using CCDL materials.
The CCDL will have a team of scientists at the American Association for Cancer Research 2020 Annual Meeting in sunny San Diego! Our team members are excited to talk to researchers studying pediatric cancer at Booth 1601.
To help keep pediatric cancer research moving forward, here are 3 ways the CCDL is helping the research community during this time: refine.bio, virtual workshops, and the Open Pediatric Brain Tumor Atlas project.
We know that pandemic-related university closures mean that the demand for opportunities for pediatric cancer researchers to increase their analytical skills has never been higher. As such, we are delighted to announce a pilot virtual workshop running from May 4-8, 2020!
Here at the Childhood Cancer Data Lab, we value transparency and the practice of open science. Much of the work we’ve done and the products that we build hinge on the generosity and openness of other scientists. In this post, as part of National Brain Tumor Awareness month, we want to talk about a project that our science team has been working on over the last few months (and to do so in a way that aligns with our values).
The workshop will take place on June 22 - 26, 2020 from noon - 5pm Eastern. Each day consists of lectures and designated time for attendees to work on exercise materials and their own projects with CCDL staff available for consultation.
When the CCDL (along with everyone else) realized that we would have to conduct our bioinformatics training workshops remotely, we had to make some quick decisions about how we were going to do it. Most of the instructional materials for our in person workshops were already online, so we knew we had a good base to work from. We just needed to figure how to adapt the live instruction.
At Alex’s Lemonade Stand Foundation’s Childhood Cancer Data Lab, we’re excited to be helping out with an upcoming event hosted by the Children’s Tumor Foundation. If you participate, you may meet members of our team who are mentoring and judging.
The workshop will take place on March 22 - 26, 2021 from noon - 5pm Eastern. Each day consists of lectures and designated time for attendees to work on exercise materials and their own projects with CCDL staff available for consultation
The workshop will take place on June 28- July 2, 2021 from noon to 5pm eastern. Each day consists of lectures and designated time for attendees to work on exercise materials and their own projects with CCDL staff available for consultation.
Hack4Rare is a virtual event that calls for healthcare startups, developers, solutions architects, and hackathon enthusiasts to join researchers, clinicians and patients in developing solutions built around a number of rare diseases including neurofibromatosis, PTEN Hamartoma Tumor Syndrome, RASopathies and Desmoid Tumors.
The workshop will take place on September 20 - 24, 2021 from noon - 5pm Eastern. Each day consists of lectures and designated time for attendees to work on exercise materials and their own projects with CCDL staff available for consultation.
Introducing refine.bio examples. Here, users can access a variety of example analyses implemented in R, such as clustering and heat maps, differential expression analysis, and pathway analysis, for use with refine.bio data.
The workshop will take place on November 1-5, 2021 from noon to 5pm eastern. Each day consists of lectures and designated time for attendees to work on exercise materials and their own projects with our staff available for consultation.
I work at the Childhood Cancer Data Lab, where we use very big data to find cures for childhood cancers. To move data around the internet at very high speeds, we are forced to use a proprietary software suite called Aspera. If somebody could make a Free Software alternative, the future of the internet would be way more awesome! Best of all, you can be the one to do it!
When my daughter Alex was diagnosed with cancer and throughout her battle, we saw how our community of people rallied around our family. No one knew quite how to help, but they were willing to do whatever was needed to ease the burden we faced.
'Work smarter not harder’ is useless advice if you don’t know how to ‘work smarter’. But the Childhood Cancer Data Lab's work and processes may be the smartest I’ve ever had the pleasure of learning and adopting.
The Data Lab will hold our first virtual workshop of the year from March 14-18, 2022!In this workshop, we will introduce researchers studying pediatric cancer to the R programming language, the Tidyverse R packages for data science, single-cell RNA-seq data analysis, and pathway analyses.
At the Data Lab, we are big proponents of automating the boring stuff so we can spend more time thinking about the fun stuff. But how exactly do we do that, and what does it mean to automate the boring stuff?
November marked the final Childhood Cancer Data Lab training workshop for 2021. We held four week-long virtual workshops this year, teaching 88 researchers the data science skills they need to examine their own data.
Before working as a Data Scientist at the Childhood Cancer Data Lab, I spent time in my PhD and post-doctoral fellowship in two very different research environments. Each had their own unique way of doing research. I found that some things worked really well and others were not as successful.
333 E. Lancaster Ave, #414
Wynnewood, PA 19096 USA
© Childhood Cancer Data Lab