Skip to content

Enhancing the Functionality and Accuracy of the VedicDateTime R Package

Simran edited this page Apr 4, 2023 · 11 revisions

Background

The VedicDateTime R package is a helpful tool for working with dates and times in the Vedic calendar system. However, the current version of the package has a number of limitations, including a lack of support for additional calendar systems and limited functionality for date and time calculations. In this project, we propose to update and improve the VedicDateTime package by implementing support for additional calendar systems, adding new functions for date and time calculations, improving the accuracy of the package, and expanding the documentation and examples. These updates will significantly enhance the functionality and accuracy of the VedicDateTime package, making it an even more valuable tool for users working with dates and times in the Vedic calendar system.

Related work

The proposed package will be the modification in the VedicDateTime package to make it more powerful and user-friendly, enabling users to more easily and accurately work with dates and times in the Vedic calendar system.

Details of your coding project

The goal of this coding project is to upgrade the 'VedicDateTime', an R package. The expected tasks for this project are as follows:

  • Implement support for additional calendar systems: The VedicDateTime package currently only supports the Surya Siddhanta and the Surya Siddhanta with True Sun calculations. We propose to implement support for additional calendar systems, such as the Sayana and the Drik Siddhanta, to increase the flexibility and utility of the package for users.
  • Add new functions for date and time calculations: The VedicDateTime package currently provides functions for performing basic date and time calculations, such as calculating the difference between two dates or adding a certain number of days to a date. We propose to add new functions for more advanced calculations, such as calculating the tithi (lunar day) at a given date and time, or finding the next full moon or new moon.
  • Improve the accuracy of the package: The accuracy of the VedicDateTime package can be improved by implementing more advanced algorithms for converting between the Vedic and Gregorian calendars, and by incorporating more accurate data for leap years and other calendar events. We propose to research and implement these improvements to ensure that the package provides the most accurate and reliable results possible.
  • Expand the documentation and examples: The VedicDateTime package currently provides some basic documentation and examples, but we propose to expand and improve upon this documentation to make it more comprehensive and user-friendly. This will include adding more detailed explanations of the functions and their inputs and outputs, as well as additional examples demonstrating their use in real-world scenarios.

Expected impact

This project will introduce a new calendar system that can have huge potential to discover meaningful patterns in natural time series. Besides, it will document the research contributions that can be a foundation for time series analysis based on a new calendar system.

Mentors

EVALUATING MENTOR: Neeraj Dhanraj Bokde, Assistant Professor, Center for Quantitative Genetics and Genomics, Aarhus University, Denmark. neerajdhanraj@gmail.com. Neeraj is Ph.D. in Data Science and contributed several R packages related to time series analysis, testbenches, and domain-specific ones. Neeraj has been a GSOC mentor since 2020. https://www.neerajbokde.in/

Prajwal Patil is graduating in Computer Science Engineering. He was GSoC contributor in 2022 and contributed to VedicDateTime package in CRAN. prajwalpatilcodes@gmail.com

Tests

Contributors, please do one or more of the following tests before contacting the mentors above.

Students, please do one or more of the following tests before contacting the mentors above.

  • Easy: Download the VedicDateTime package and demonstrate it with a naturally occurring time series. Document it with RMarkdown.

  • Medium: Suggest possible updates or a new feature you would like to include in the next version of the VedicDateTime package.

  • Hard: Develop a dummy code of 5 functions and a vignette and pass it with no Error/Warning/Note through https://win-builder.r-project.org/

Solutions of tests

Contributors, please post a link to your test results here.

  • EXAMPLE CONTRIBUTOR 1 NAME, LINK TO GITHUB PROFILE, LINK TO TEST RESULTS.
Contributor Name GitHub Profile Test Results
Avinab Neogy https://github.com/avinabneogy23 https://github.com/avinabneogy23/GSOC-23vdt
Alesia Tratsiakova https://github.com/AlesiaT Easy - https://github.com/AlesiaT/R_examples ; Hard - https://github.com/sineadquig/IrwinHallFunctions Disclaimer! This code was created as a group project for my university. I am an author of all R functions in this package, but the vignette and tests were created by other two students.
Sourabh Tiwari https://github.com/Sourabh-tiwari22 https://github.com/Sourabh-tiwari22/GSoC_2023_Tests
Simran Chaudhary https://github.com/67simran https://github.com/67simran/GSOC-2023-R
Clone this wiki locally