Questions to consider:
Guidance:
Give a brief description of the data, including any existing data or third-party sources that will be used, in each case noting its content, type and coverage. Outline and justify your choice of format and consider the implications of data format and data volumes in terms of storage, backup and access.
", - themes: ["Theme 2"] - }, - "How will the data be collected or created?" => { - text: "How will the data be collected or created?", - section: "Data Collection", - number: 2, - guidance: "Questions to consider:
Guidance:
Outline how the data will be collected/created and which community data standards (if any) will be used. Consider how the data will be organised during the project, mentioning for example naming conventions, version control and folder structures. Explain how the consistency and quality of data collection will be controlled and documented. This may include processes such as calibration, repeat samples or measurements, standardised data capture or recording, data entry validation, peer review of data or representation with controlled vocabularies.
", - themes: ["Theme 3"] - }, - "What documentation and metadata will accompany the data?" => { - text: "What documentation and metadata will accompany the data?", - section: "Documentation and Metadata", - number: 1, - guidance: "Questions to consider:
Guidance:
Describe the types of documentation that will accompany the data to help secondary users to understand and reuse it. This should at least include basic details that will help people to find the data, including who created or contributed to the data, its title, date of creation and under what conditions it can be accessed.
Documentation may also include details on the methodology used, analytical and procedural information, definitions of variables, vocabularies, units of measurement, any assumptions made, and the format and file type of the data. Consider how you will capture this information and where it will be recorded. Wherever possible you should identify and use existing community standards.
", - themes: ["Theme 1"] - }, - "Data Overview" => { - text: "Overview of the Data", - section: "Data Overview", - number: 1, - guidance: "Things to consider:
Things to consider:
Questions to consider:
Guidance:
Ethical issues affect how you store data, who can see/use it and how long it is kept. Managing ethical concerns may include: anonymisation of data; referral to departmental or institutional ethics committees; and formal consent agreements. You should show that you are aware of any issues and have planned accordingly. If you are carrying out research involving human participants, you must also ensure that consent is requested to allow data to be shared and reused.
", - themes: ["Theme 4"] - }, - "How will you manage copyright and Intellectual Property Rights (IPR) issues?" => { - text: "How will you manage copyright and Intellectual Property Rights (IPR) issues?", - section: "Ethics and Legal Compliance", - number: 2, - guidance: "Questions to consider:
Guidance:
State who will own the copyright and IPR of any data that you will collect or create, along with the licence(s) for its use and reuse. For multi-partner projects, IPR ownership may be worth covering in a consortium agreement. Consider any relevant funder, institutional, departmental or group policies on copyright or IPR. Also consider permissions to reuse third-party data and any restrictions needed on data sharing.
", - themes: ["Theme 1"] - }, - "How will the data be stored and backed up during the research?" => { - text: "How will the data be stored and backed up during the research?", - section: "Storage and Backup", - number: 1, - guidance: "Questions to consider:
Guidance:
State how often the data will be backed up and to which locations. How many copies are being made? Storing data on laptops, computer hard drives or external storage devices alone is very risky. The use of robust, managed storage provided by university IT teams is preferable. Similarly, it is normally better to use automatic backup services provided by IT Services than rely on manual processes. If you choose to use a third-party service, you should ensure that this does not conflict with any funder, institutional, departmental or group policies, for example in terms of the legal jurisdiction in which data are held or the protection of sensitive data.
", - themes: ["Theme 2"] - }, - "4a: Preserving Your Data" => { - text: "4a: Preserving Your Data", - section: "Preservation, Sustainability and Use", - number: 1, - guidance: "Preservation of digital outputs is necessary in order for them to endure changes in the technological environment and remain potentially re-usable in the future. In this section you must state what, if any, digital outputs of your project you intend to preserve beyond the period of funding.
The length and cost of preservation should be proportionate to the value and significance of the digital outputs. If you believe that none of these should be preserved this must be justified, and if the case is a good one the application will not be prejudiced.
You must consider preservation in four ways: what, where, how and for how long. You must also consider any institutional support needed in order to carry out these plans, whether from an individual, facility, organisation or service.
You should think about the possibilities for re-use of your data in other contexts and by other users, and connect this as appropriate with your plans for dissemination and Pathways to Impact.Where there is potential for re-usability, you should use standards and formats that facilitate this.
The Technical Reviewer will be looking for evidence that you understand the reasons for the choice of technical standards and formats described in Section 2.a Technical Methodology: Standards and Formats.
You should describe the types of documentation which will accompany the data. Documentation in this sense means technical documentation as well as user documentation. It includes, for instance, technical description, code commenting, project-build guidelines, the documentation of technical decisions and resource metadata which is additional to the standards which you have described in Section 2.a. Not all types of documentation will be relevant to a project and the quantity of documentation proposed should be proportionate to the envisaged value of the data.
", - themes: ["Theme 2", "Theme 3", "Theme 4"] - }, - "4b: Ensuring Continued Accessibility and Use of Your Digital Outputs" => { - text: "4b: Ensuring Continued Accessibility and Use of Your Digital Outputs", - section: "Preservation, Sustainability and Use", - number: 2, - guidance: "In this section you must provide information about any plans for ensuring that digital outputs remain sustainable in the sense of immediately accessible and usable beyond the period of funding. There are costs to ensuring sustainability in this sense over and above the costs of preservation. The project's sustainability plan should therefore be proportionate to the envisaged longer-term value of the data for the research community and should be closely related to your plans for dissemination and Pathways to Impact.
If you believe that digital outputs should not be sustained beyond the period of funding then this should be justified. It is not mandatory to sustain all digital outputs. While you should consider the long-term value of the digital outputs to the research community, where they are purely ancillary to a project’s research outputs there may not be a case for sustaining them (though there would usually be a case for preservation).
You must consider the sustainability of your digital outputs in five ways: what, where, how, for how long, and how the cost will be covered. You must make appropriate provision for user consultation and user testing in this connection, and plan the development of suitable user documentation.
You should provide justification if you do not envisage open, public access. A case can be made for charging for or otherwise limiting access, but the default expectation is that access will be open. The Technical Reviewer will be looking for realistic commitments to sustaining public access in line with affordability and the longer-term value of the digital output.
You must consider any institutional support needed in order to carry out these plans, if not covered under Section 3, as well as the cost of keeping the digital output publicly available in the future, including issues relating to maintenance, infrastructure and upgrade (such as the need to modify aspects of a web interface or software application in order to account for changes in the technological environment). In order to minimise sustainability costs, it is generally useful that the expertise involved in the development of your project is supported by expertise in your own or a partner institution.
A sustainability plan does not necessarily mean a requirement to generate income or prevent resources from being freely available. Rather it is a requirement to consider the direct costs and expertise of maintaining digital outputs for continued access. Some applicants might be able to demonstrate that there will be no significant sustainability problems with their digital output; in some cases the university’s computing services or library might provide a firm commitment to sustaining the resource for a specified period; others might see the benefit of Open Source community development models. You should provide reassurances of sustainability which are proportionate to the envisaged longer-term value of the digital outputs for the research community.
When completing this section, you should consider the potential impact of the data on research in your field (if research in the discipline will be improved through the creation of the digital output, how will it be affected if the resource then disappears?), and make the necessary connections with your Impact Plan. You must factor in the effects of any IP, copyright and ethical issues during the period in which the digital output will be publicly accessible, connecting what you say with the relevant part of your Case for Support.
You must identify whether or not you envisage the academic content (as distinct from the technology) of the digital output being extended or updated beyond the period of funding, addressing the following issues: how this will be done, by who and at what cost. You will need to show how the cost of this will be sustained after the period of funding ends.
", - themes: ["Theme 2"] - } - } +# Create questions for the 2 templates and their phases/sections +# ------------------------------------------------------- +questions = [ + # Questions for the 'Generic DMP' phase of the 'My Curation Center's Default Template' + {number: 1, + text: "What data will you collect or create?", + section: generic_template_phase_1.sections.find_by(number: 1), + question_format: text_area_format, + modifiable: false}, + {number: 2, + text: "How will the data be collected or created?", + section: generic_template_phase_1.sections.find_by(number: 1), + question_format: text_area_format, + modifiable: false}, + {number: 1, + text: "What documentation and metadata will accompany the data?", + section: generic_template_phase_1.sections.find_by(number: 2), + question_format: text_area_format, + modifiable: false}, + {number: 1, + text: "How will you manage ethical issues?", + section: generic_template_phase_1.sections.find_by(number: 3), + question_format: text_area_format, + modifiable: false}, + {number: 2, + text: "How will you manage copyright and Intellectual Property Rights (IPR) issues?", + section: generic_template_phase_1.sections.find_by(number: 3), + question_format: text_area_format, + modifiable: false}, + {number: 1, + text: "How will the data be stored and backed up during the research?", + section: generic_template_phase_1.sections.find_by(number: 4), + question_format: text_area_format, + modifiable: false}, + {number: 2, + text: "How will you manage access and security?", + section: generic_template_phase_1.sections.find_by(number: 4), + question_format: text_area_format, + modifiable: false}, + {number: 1, + text: "Which data are of long-term value and should be retained, shared, and/or preserved?", + section: generic_template_phase_1.sections.find_by(number: 5), + question_format: text_area_format, + modifiable: false}, + {number: 2, + text: "What is the long-term preservation plan for the dataset?", + section: generic_template_phase_1.sections.find_by(number: 5), + question_format: text_area_format, + modifiable: false}, + {number: 1, + text: "How will you share the data?", + section: generic_template_phase_1.sections.find_by(number: 6), + question_format: text_area_format, + modifiable: false}, + {number: 2, + text: "Are any restrictions on data sharing required?", + section: generic_template_phase_1.sections.find_by(number: 6), + question_format: text_area_format, + modifiable: false}, + {number: 1, + text: "Who will be responsible for data management?", + section: generic_template_phase_1.sections.find_by(number: 7), + question_format: text_area_format, + modifiable: false}, + {number: 2, + text: "What resources will you require to deliver your plan?", + section: generic_template_phase_1.sections.find_by(number: 7), + question_format: text_area_format, + modifiable: false}, + + # Questions for the 'Preliminary Statement of Work' phase of the 'Department of Testing Award' + {number: 1, + text: "Please provide a description of the type(s) of data you plan to collect.", + default_value: "Statistical data stored in csv files, images in the RAW format, etc.", + section: funder_template_phase_1.sections.find_by(number: 1), + question_format: text_area_format, + modifiable: false}, + {number: 1, + text: "Please describe your methods for gathering and storing the data.", + section: funder_template_phase_1.sections.find_by(number: 2), + question_format: text_area_format, + modifiable: false}, + + # Questions for the 'Detailed Overview' phase of the 'Department of Testing Award' + {number: 1, + text: "Please describe your departmental and institutional policies about preserving research data.", + section: funder_template_phase_2.sections.find_by(number: 1), + question_format: text_area_format, + modifiable: false}, + + {number: 1, + text: "Please list all data formats you intend to collect and provide a description of the storage facilities you intend to use.", + section: funder_template_phase_2.sections.find_by(number: 2), + question_format: text_area_format, + modifiable: false}, + {number: 2, + text: "Will require store your data in your institution's repository?", + section: funder_template_phase_2.sections.find_by(number: 2), + question_format: QuestionFormat.find_by(title: 'Check box'), + modifiable: false}, + + {number: 1, + text: "How will you go about collecting your data?", + section: funder_template_phase_2.sections.find_by(number: 3), + question_format: text_area_format, + modifiable: false}, + + {number: 1, + text: "How will you ensure that your data does not contain sensitive information like personal email addresses, social security number, names, etc.", + section: funder_template_phase_2.sections.find_by(number: 4), + question_format: text_area_format, + modifiable: false}, + + {number: 1, + text: "Please describe your overall plan for preservation and reuse.", + default_value: "Enter your policy guidelines here ...", + section: funder_template_phase_2.sections.find_by(number: 5), + question_format: text_area_format, + modifiable: false}, + {number: 2, + text: "What type of license will you use?", + section: funder_template_phase_2.sections.find_by(number: 5), + question_format: QuestionFormat.find_by(title: 'Dropdown'), + modifiable: false}, + {number: 3, + text: "When will the data be made available to the public?", + guidance: "The date can be approximate.", + section: funder_template_phase_2.sections.find_by(number: 5), + question_format: QuestionFormat.find_by(title: 'Date'), + modifiable: false} +] +questions.map{ |s| Question.create!(s) if Question.find_by(text: s[:text]).nil? } - questions.each do |q, details| - if Question.where(text: details[:text]).empty? - question = Question.new - question.text = details[:text] - question.number = details[:number] - question.guidance = details[:guidance] - question.section = Section.find_by_title(details[:section]) - details[:themes].each do |theme| - question.themes << Theme.find_by_title(theme) - end - question.save! - end - end -formatting = { - 'Funder' => { - font_face: "Arial, Helvetica, Sans-Serif", - font_size: 11, - margin: { top: 20, bottom: 20, left: 20, right: 20 } - }, - 'DCC' => { - font_face: "Arial, Helvetica, Sans-Serif", - font_size: 12, - margin: { top: 20, bottom: 20, left: 20, right: 20 } - } -} - -formatting.each do |org, settings| - #template = Dmptemplate.find_by_title("#{org} Template") # this is bugged, there is no Funder Template nor DCC template - #template.settings(:export).formatting = settings - #template.save! -end - -token_permission_types = { - 'guidances' => { - description: "allows a user access to the guidances api endpoint" - }, - 'plans' => { - description: "allows a user access to the plans api endpoint" - }, - 'templates' => { - description: "allows a user access to the templates api endpoint" - }, - 'statistics' => { - description: "allows a user access to the statistics api endpoint" - } -} - -token_permission_types.each do |title,settings| - if TokenPermissionType.where(token_type: title).empty? - token_permission_type = TokenPermissionType.new - token_permission_type.token_type = title - token_permission_type.text_description = settings[:description] - token_permission_type.save! - end -end -=end \ No newline at end of file +# Create some options for our dropdown question +# ------------------------------------------------------- +license_question = Question.find_by(text: "What type of license will you use?") +license_question_options = [ + {question: license_question, + text: "BSD", + number: 1, + is_default: false}, + {question: license_question, + text: "GNU", + number: 2, + is_default: false}, + {question: license_question, + text: "MIT", + number: 3, + is_default: true} +] +license_question_options.map{ |q| QuestionOption.create!(q) if QuestionOption.find_by(text: q[:text]).nil? } \ No newline at end of file