Community docs

Documenting your project

Once you have created a project and added your files to it, you can make it easier to find and more useful to others by describing, or documenting it. Documenting consists of creating the metadata for your dataset or project and helps others to trust your data and work.  Searches on data.world also look at titles, descriptions, summary, and tags to match search strings so the more completely you describe your data the more chance it has of being found.

Posting insights

When you have findings, conclusions, or interesting points for discussion about your project, you can create an Insight to display them prominently and invite discussion with other contributors to the project. Insights allow you to capture the conclusions from your work and present them in a way that quickly communicates a nugget of information, while giving the viewer the tools they need to dig down into your methods and sources. Insights balance efficiency of communication with reproducibility--two concepts that are often at odds in this phase of data work.

You can use insights to capture the results and analysis of your work and synthesize them so they are understandable and accessible to stakeholders at all levels in the project. Insights can be created by the project owner and any contributors, and are the first thing that displays on the main overview page. They also have their own tab in the project.

There are several places you can add an insight to your project:

  • On the Overview tab with the New insight button

Screen_Shot_2019-08-16_at_10.47.46_AM.png
  • On the Insights tab with the Add a new insight button

Screen_Shot_2019-08-16_at_10.49.16_AM.png
  • From the project workspace after clicking the + Add button

Screen_Shot_2019-08-16_at_10.50.45_AM.png

NOTE: Insight titles are a main search field in data.world. Make sure you use a descriptive title so it can be easily found with search. To find out more about how search works see the article Using Search.

When you create a new Insight, you will enter the Simple Editor - the same editor used for dataset and project summaries. You can switch to Markdown from the link next to the Done button if you prefer. For more information on using the Simple Editor, see:

For more information on Markdown see our Markdown syntax reference.

Citing data

When citing and sharing data found on data.world, please cite the original data source and URL where you've retrieved the data from data.world.

A dataset citation should include the same components that any other citation would include:

  • author

  • title

  • year of publication

  • publisher (for data this is often where it is housed, i.e. data.world in this case)

  • edition or version

  • access information (a URL or other persistent identifier, i.e. the dataset URL)

It is very important to note that some datasets may have special instructions on how to cite or use their data. Be sure to check the dataset summary for any additional requirements or guidelines.

To learn more about licensing, see:

How to cite using the APA Style Guide.

Format:

Author/Rightsholder. (Year). Title of data set (Version number) [Description of form]. Retrieved from http://data.world/[accountname]/[dataset]

Example - Citing the Federal government awards in Q2 published by the Treasury Department’s account @usaspending

USAspending.gov. (2017). Federal government awards in Q2. Retrieved from https://data.world/usaspending/federal-government-awards-in-q-2.

Example - Citing Ride Austin’s ride data

Ride Austin. (2017). Ride-Austin-june6-april13 [Data file and code book]. Reitrieved from https://data.world/ride-austin/ride-austin-june-6-april-13

Citation Resources